#[non_exhaustive]pub struct CreateNotebookInstanceInput { /* private fields */ }
Implementations§
source§impl CreateNotebookInstanceInput
impl CreateNotebookInstanceInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateNotebookInstance, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateNotebookInstance, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<CreateNotebookInstance
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateNotebookInstanceInput
.
source§impl CreateNotebookInstanceInput
impl CreateNotebookInstanceInput
sourcepub fn notebook_instance_name(&self) -> Option<&str>
pub fn notebook_instance_name(&self) -> Option<&str>
The name of the new notebook instance.
sourcepub fn instance_type(&self) -> Option<&InstanceType>
pub fn instance_type(&self) -> Option<&InstanceType>
The type of ML compute instance to launch for the notebook instance.
sourcepub fn subnet_id(&self) -> Option<&str>
pub fn subnet_id(&self) -> Option<&str>
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
sourcepub fn security_group_ids(&self) -> Option<&[String]>
pub fn security_group_ids(&self) -> Option<&[String]>
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
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.
To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole
permission.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
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 in the Amazon Web Services Key Management Service Developer Guide.
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.
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 direct_internet_access(&self) -> Option<&DirectInternetAccess>
pub fn direct_internet_access(&self) -> Option<&DirectInternetAccess>
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. You can set the value of this parameter to Disabled
only if you set a value for the SubnetId
parameter.
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.
sourcepub fn accelerator_types(&self) -> Option<&[NotebookInstanceAcceleratorType]>
pub fn accelerator_types(&self) -> Option<&[NotebookInstanceAcceleratorType]>
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.
sourcepub fn default_code_repository(&self) -> Option<&str>
pub fn default_code_repository(&self) -> Option<&str>
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 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.
sourcepub fn additional_code_repositories(&self) -> Option<&[String]>
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.
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
.
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.
sourcepub fn platform_identifier(&self) -> Option<&str>
pub fn platform_identifier(&self) -> Option<&str>
The platform identifier of the notebook instance runtime environment.
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
Trait Implementations§
source§impl Clone for CreateNotebookInstanceInput
impl Clone for CreateNotebookInstanceInput
source§fn clone(&self) -> CreateNotebookInstanceInput
fn clone(&self) -> CreateNotebookInstanceInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateNotebookInstanceInput
impl Debug for CreateNotebookInstanceInput
source§impl PartialEq<CreateNotebookInstanceInput> for CreateNotebookInstanceInput
impl PartialEq<CreateNotebookInstanceInput> for CreateNotebookInstanceInput
source§fn eq(&self, other: &CreateNotebookInstanceInput) -> bool
fn eq(&self, other: &CreateNotebookInstanceInput) -> bool
self
and other
values to be equal, and is used
by ==
.