#[non_exhaustive]pub struct UpdateNotebookInstanceInput {Show 14 fields
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)§
This struct is marked as non-exhaustive
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 AI can assume to access the notebook instance. For more information, see SageMaker AI Roles.
To be able to pass this role to SageMaker AI, 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 AI 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 AI 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 AI Notebook Instances.
accelerator_types: Option<Vec<NotebookInstanceAcceleratorType>>
This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types to associate with this notebook instance.
disassociate_accelerator_types: Option<bool>
This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types to remove from this notebook instance.
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§
Source§impl UpdateNotebookInstanceInput
impl UpdateNotebookInstanceInput
Sourcepub fn notebook_instance_name(&self) -> Option<&str>
pub fn notebook_instance_name(&self) -> Option<&str>
The name of the notebook instance to update.
Sourcepub fn instance_type(&self) -> Option<&InstanceType>
pub fn instance_type(&self) -> Option<&InstanceType>
The Amazon ML compute instance type.
Sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to access the notebook instance. For more information, see SageMaker AI Roles.
To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole
permission.
Sourcepub fn lifecycle_config_name(&self) -> Option<&str>
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.
Sourcepub fn disassociate_lifecycle_config(&self) -> Option<bool>
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.
Sourcepub fn volume_size_in_gb(&self) -> Option<i32>
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 AI 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.
Sourcepub fn default_code_repository(&self) -> Option<&str>
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 AI Notebook Instances.
Sourcepub fn additional_code_repositories(&self) -> &[String]
pub fn additional_code_repositories(&self) -> &[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 AI Notebook Instances.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_code_repositories.is_none()
.
Sourcepub fn accelerator_types(&self) -> &[NotebookInstanceAcceleratorType]
pub fn accelerator_types(&self) -> &[NotebookInstanceAcceleratorType]
This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types to associate with this notebook instance.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .accelerator_types.is_none()
.
Sourcepub fn disassociate_accelerator_types(&self) -> Option<bool>
pub fn disassociate_accelerator_types(&self) -> Option<bool>
This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types to remove from this notebook instance.
Sourcepub fn disassociate_default_code_repository(&self) -> Option<bool>
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.
Sourcepub fn disassociate_additional_code_repositories(&self) -> Option<bool>
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.
Sourcepub fn root_access(&self) -> Option<&RootAccess>
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.
Sourcepub fn instance_metadata_service_configuration(
&self,
) -> Option<&InstanceMetadataServiceConfiguration>
pub fn instance_metadata_service_configuration( &self, ) -> Option<&InstanceMetadataServiceConfiguration>
Information on the IMDS configuration of the notebook instance
Source§impl UpdateNotebookInstanceInput
impl UpdateNotebookInstanceInput
Sourcepub fn builder() -> UpdateNotebookInstanceInputBuilder
pub fn builder() -> UpdateNotebookInstanceInputBuilder
Creates a new builder-style object to manufacture UpdateNotebookInstanceInput
.
Trait Implementations§
Source§impl Clone for UpdateNotebookInstanceInput
impl Clone for UpdateNotebookInstanceInput
Source§fn clone(&self) -> UpdateNotebookInstanceInput
fn clone(&self) -> UpdateNotebookInstanceInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for UpdateNotebookInstanceInput
impl Debug for UpdateNotebookInstanceInput
impl StructuralPartialEq for UpdateNotebookInstanceInput
Auto Trait Implementations§
impl Freeze for UpdateNotebookInstanceInput
impl RefUnwindSafe for UpdateNotebookInstanceInput
impl Send for UpdateNotebookInstanceInput
impl Sync for UpdateNotebookInstanceInput
impl Unpin for UpdateNotebookInstanceInput
impl UnwindSafe for UpdateNotebookInstanceInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);