Struct aws_sdk_sagemaker::operation::update_notebook_instance::UpdateNotebookInstanceInput

#[non_exhaustive]
pub struct UpdateNotebookInstanceInput {

    pub notebook_instance_name: Option<String>,
    pub instance_type: Option<InstanceType>,
    pub role_arn: Option<String>,
    pub lifecycle_config_name: Option<String>,
    pub disassociate_lifecycle_config: Option<bool>,
    pub volume_size_in_gb: Option<i32>,
    pub default_code_repository: Option<String>,
    pub additional_code_repositories: Option<Vec<String>>,
    pub accelerator_types: Option<Vec<NotebookInstanceAcceleratorType>>,
    pub disassociate_accelerator_types: Option<bool>,
    pub disassociate_default_code_repository: Option<bool>,
    pub disassociate_additional_code_repositories: Option<bool>,
    pub root_access: Option<RootAccess>,
    pub instance_metadata_service_configuration: Option<InstanceMetadataServiceConfiguration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

notebook_instance_name: Option<String>

The name of the notebook instance to update.

instance_type: Option<InstanceType>

The Amazon ML compute instance type.

role_arn: Option<String>

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

lifecycle_config_name: Option<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.

disassociate_lifecycle_config: Option<bool>

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

volume_size_in_gb: Option<i32>

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

default_code_repository: Option<String>

The 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 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.

additional_code_repositories: Option<Vec<String>>

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 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.

accelerator_types: Option<Vec<NotebookInstanceAcceleratorType>>

A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

disassociate_accelerator_types: Option<bool>

A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

disassociate_default_code_repository: Option<bool>

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

disassociate_additional_code_repositories: Option<bool>

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

root_access: Option<RootAccess>

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

instance_metadata_service_configuration: Option<InstanceMetadataServiceConfiguration>

Information on the IMDS configuration of the notebook instance

Implementations

impl UpdateNotebookInstanceInput

pub fn notebook_instance_name(&self) -> Option<&str>

The name of the notebook instance to update.

pub fn instance_type(&self) -> Option<&InstanceType>

The Amazon ML compute instance type.

pub fn role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

pub fn lifecycle_config_name(&self) -> Option<&str>

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.

pub fn disassociate_lifecycle_config(&self) -> Option<bool>

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

pub fn volume_size_in_gb(&self) -> Option<i32>

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

pub fn default_code_repository(&self) -> Option<&str>

The 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 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.

pub fn additional_code_repositories(&self) -> Option<&[String]>

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 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.

pub fn accelerator_types(&self) -> Option<&[NotebookInstanceAcceleratorType]>

A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

pub fn disassociate_accelerator_types(&self) -> Option<bool>

A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

pub fn disassociate_default_code_repository(&self) -> Option<bool>

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

pub fn disassociate_additional_code_repositories(&self) -> Option<bool>

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

pub fn root_access(&self) -> Option<&RootAccess>

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

pub fn instance_metadata_service_configuration( &self ) -> Option<&InstanceMetadataServiceConfiguration>

Information on the IMDS configuration of the notebook instance

impl UpdateNotebookInstanceInput

pub fn builder() -> UpdateNotebookInstanceInputBuilder

Creates a new builder-style object to manufacture UpdateNotebookInstanceInput.

Trait Implementations

impl Clone for UpdateNotebookInstanceInput

fn clone(&self) -> UpdateNotebookInstanceInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateNotebookInstanceInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<UpdateNotebookInstanceInput> for UpdateNotebookInstanceInput

fn eq(&self, other: &UpdateNotebookInstanceInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateNotebookInstanceInput