notebook_instance.go

// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"). You may
// not use this file except in compliance with the License. A copy of the
// License is located at
//
//     http://aws.amazon.com/apache2.0/
//
// or in the "license" file accompanying this file. This file is distributed
// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
// express or implied. See the License for the specific language governing
// permissions and limitations under the License.

// Code generated by ack-generate. DO NOT EDIT.

package v1alpha1

import (
	ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// NotebookInstanceSpec defines the desired state of NotebookInstance.
type NotebookInstanceSpec struct {

	// This parameter is no longer supported. Elastic Inference (EI) is no longer
	// available.
	//
	// This parameter was used to specify a list of EI instance types to associate
	// with this notebook instance.
	AcceleratorTypes []*string `json:"acceleratorTypes,omitempty"`
	// An array of up to three Git repositories to associate with the notebook instance.
	// These can be either the names of Git repositories stored as resources in
	// your account, or the URL of Git repositories in Amazon Web Services CodeCommit
	// (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or
	// in any other Git repository. These repositories are cloned at the same level
	// as the default repository of your notebook instance. For more information,
	// see Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html).
	AdditionalCodeRepositories []*string `json:"additionalCodeRepositories,omitempty"`
	// A Git repository to associate with the notebook instance as its default code
	// repository. This can be either the name of a Git repository stored as a resource
	// in your account, or the URL of a Git repository in Amazon Web Services CodeCommit
	// (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or
	// in any other Git repository. When you open a notebook instance, it opens
	// in the directory that contains this repository. For more information, see
	// Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html).
	//
	// Regex Pattern: `^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`
	DefaultCodeRepository *string `json:"defaultCodeRepository,omitempty"`
	// 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.
	DirectInternetAccess *string `json:"directInternetAccess,omitempty"`
	// The type of ML compute instance to launch for the notebook instance.
	// +kubebuilder:validation:Required
	InstanceType *string `json:"instanceType"`
	// 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.
	//
	// Regex Pattern: `^[a-zA-Z0-9:/_-]*$`
	KMSKeyID *string `json:"kmsKeyID,omitempty"`
	// 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).
	//
	// Regex Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`
	LifecycleConfigName *string `json:"lifecycleConfigName,omitempty"`
	// The name of the new notebook instance.
	//
	// Regex Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`
	// +kubebuilder:validation:Required
	NotebookInstanceName *string `json:"notebookInstanceName"`
	// The platform identifier of the notebook instance runtime environment.
	//
	// Regex Pattern: `^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3)$`
	PlatformIdentifier *string `json:"platformIdentifier,omitempty"`
	// 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.
	//
	// Regex Pattern: `^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$`
	// +kubebuilder:validation:Required
	RoleARN *string `json:"roleARN"`
	// 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.
	RootAccess *string `json:"rootAccess,omitempty"`
	// 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 []*string `json:"securityGroupIDs,omitempty"`
	// The ID of the subnet in a VPC to which you would like to have a connectivity
	// from your ML compute instance.
	//
	// Regex Pattern: `^[-0-9a-zA-Z]+$`
	SubnetID *string `json:"subnetID,omitempty"`
	// 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 []*Tag `json:"tags,omitempty"`
	// The size, in GB, of the ML storage volume to attach to the notebook instance.
	// The default value is 5 GB.
	VolumeSizeInGB *int64 `json:"volumeSizeInGB,omitempty"`
}

// NotebookInstanceStatus defines the observed state of NotebookInstance
type NotebookInstanceStatus struct {
	// 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
	// +kubebuilder:validation:Optional
	ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"`
	// 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
	// +kubebuilder:validation:Optional
	Conditions []*ackv1alpha1.Condition `json:"conditions"`
	// If status is Failed, the reason it failed.
	// +kubebuilder:validation:Optional
	FailureReason *string `json:"failureReason,omitempty"`
	// The status of the notebook instance.
	// +kubebuilder:validation:Optional
	NotebookInstanceStatus *string `json:"notebookInstanceStatus,omitempty"`
	// The URL that you use to connect to the Jupyter notebook that is running in
	// your notebook instance.
	// +kubebuilder:validation:Optional
	URL *string `json:"url,omitempty"`
	// The URL that you use to connect to the Jupyter notebook that is running in
	// your notebook instance.
	// +kubebuilder:validation:Optional
	StoppedByControllerMetadata *string `json:"stoppedByControllerMetadata,omitempty"`
}

// NotebookInstance is the Schema for the NotebookInstances API
// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="FAILURE-REASON",type=string,priority=1,JSONPath=`.status.failureReason`
// +kubebuilder:printcolumn:name="STATUS",type=string,priority=0,JSONPath=`.status.notebookInstanceStatus`
type NotebookInstance struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              NotebookInstanceSpec   `json:"spec,omitempty"`
	Status            NotebookInstanceStatus `json:"status,omitempty"`
}

// NotebookInstanceList contains a list of NotebookInstance
// +kubebuilder:object:root=true
type NotebookInstanceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []NotebookInstance `json:"items"`
}

func init() {
	SchemeBuilder.Register(&NotebookInstance{}, &NotebookInstanceList{})
}