Struct aws_sdk_sagemaker::operation::create_notebook_instance::builders::CreateNotebookInstanceFluentBuilder

pub struct CreateNotebookInstanceFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateNotebookInstance.

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, SageMaker does the following:

1. Creates a network interface in the SageMaker VPC.

2. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

3. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.

After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models.

For more information, see How It Works.

Implementations

impl CreateNotebookInstanceFluentBuilder

pub async fn customize( self ) -> Result<CustomizableOperation<CreateNotebookInstance, AwsResponseRetryClassifier>, SdkError<CreateNotebookInstanceError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send( self ) -> Result<CreateNotebookInstanceOutput, SdkError<CreateNotebookInstanceError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn notebook_instance_name(self, input: impl Into<String>) -> Self

The name of the new notebook instance.

pub fn set_notebook_instance_name(self, input: Option<String>) -> Self

The name of the new notebook instance.

pub fn instance_type(self, input: InstanceType) -> Self

The type of ML compute instance to launch for the notebook instance.

pub fn set_instance_type(self, input: Option<InstanceType>) -> Self

The type of ML compute instance to launch for the notebook instance.

pub fn subnet_id(self, input: impl Into<String>) -> Self

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

pub fn set_subnet_id(self, input: Option<String>) -> Self

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

pub fn security_group_ids(self, input: impl Into<String>) -> Self

Appends an item to SecurityGroupIds.

To override the contents of this collection use set_security_group_ids.

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

pub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

pub fn role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_role_arn(self, input: Option<String>) -> Self

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.

pub fn kms_key_id(self, input: impl Into<String>) -> Self

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.

pub fn set_kms_key_id(self, input: Option<String>) -> Self

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.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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.

pub fn lifecycle_config_name(self, input: impl Into<String>) -> Self

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 set_lifecycle_config_name(self, input: Option<String>) -> Self

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 direct_internet_access(self, input: DirectInternetAccess) -> Self

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.

pub fn set_direct_internet_access( self, input: Option<DirectInternetAccess> ) -> Self

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.

pub fn volume_size_in_gb(self, input: i32) -> Self

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

pub fn set_volume_size_in_gb(self, input: Option<i32>) -> Self

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

pub fn accelerator_types(self, input: NotebookInstanceAcceleratorType) -> Self

Appends an item to AcceleratorTypes.

To override the contents of this collection use set_accelerator_types.

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.

pub fn set_accelerator_types( self, input: Option<Vec<NotebookInstanceAcceleratorType>> ) -> Self

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.

pub fn default_code_repository(self, input: impl Into<String>) -> Self

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.

pub fn set_default_code_repository(self, input: Option<String>) -> Self

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.

pub fn additional_code_repositories(self, input: impl Into<String>) -> Self

Appends an item to AdditionalCodeRepositories.

To override the contents of this collection use set_additional_code_repositories.

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 set_additional_code_repositories( self, input: Option<Vec<String>> ) -> Self

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 root_access(self, input: RootAccess) -> Self

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.

pub fn set_root_access(self, input: Option<RootAccess>) -> Self

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.

pub fn platform_identifier(self, input: impl Into<String>) -> Self

The platform identifier of the notebook instance runtime environment.

pub fn set_platform_identifier(self, input: Option<String>) -> Self

The platform identifier of the notebook instance runtime environment.

pub fn instance_metadata_service_configuration( self, input: InstanceMetadataServiceConfiguration ) -> Self

Information on the IMDS configuration of the notebook instance

pub fn set_instance_metadata_service_configuration( self, input: Option<InstanceMetadataServiceConfiguration> ) -> Self

Information on the IMDS configuration of the notebook instance

Trait Implementations

impl Clone for CreateNotebookInstanceFluentBuilder

fn clone(&self) -> CreateNotebookInstanceFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateNotebookInstanceFluentBuilder

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

Formats the value using the given formatter.