Struct aws_sdk_sagemaker::output::describe_notebook_instance_output::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for DescribeNotebookInstanceOutput

Implementations

impl Builder

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

The Amazon Resource Name (ARN) of the notebook instance.

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

The Amazon Resource Name (ARN) of the notebook instance.

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

The name of the Amazon SageMaker notebook instance.

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

The name of the Amazon SageMaker notebook instance.

pub fn notebook_instance_status(self, input: NotebookInstanceStatus) -> Self

The status of the notebook instance.

pub fn set_notebook_instance_status(
    self,
    input: Option<NotebookInstanceStatus>
) -> Self

The status of the notebook instance.

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

If status is Failed, the reason it failed.

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

If status is Failed, the reason it failed.

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

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

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

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

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

The type of ML compute instance running on the notebook instance.

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

The type of ML compute instance running on the notebook instance.

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

The ID of the VPC subnet.

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

The ID of the VPC subnet.

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

Appends an item to security_groups.

To override the contents of this collection use set_security_groups.

The IDs of the VPC security groups.

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

The IDs of the VPC security groups.

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

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

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

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

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

The Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

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

The Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

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

The network interface IDs that Amazon SageMaker created at the time of creating the instance.

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

The network interface IDs that Amazon SageMaker created at the time of creating the instance.

pub fn last_modified_time(self, input: DateTime) -> Self

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

pub fn set_last_modified_time(self, input: Option<DateTime>) -> Self

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

pub fn creation_time(self, input: DateTime) -> Self

A timestamp. Use this parameter to return the time when the notebook instance was created

pub fn set_creation_time(self, input: Option<DateTime>) -> Self

A timestamp. Use this parameter to return the time when the notebook instance was created

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

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

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

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

pub fn direct_internet_access(self, input: DirectInternetAccess) -> Self

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

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

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

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

The size, in GB, of the ML storage volume attached to the notebook instance.

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

The size, in GB, of the ML storage volume attached to the notebook instance.

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

Appends an item to accelerator_types.

To override the contents of this collection use set_accelerator_types.

A list of the Elastic Inference (EI) instance types associated 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 set_accelerator_types(
    self,
    input: Option<Vec<NotebookInstanceAcceleratorType>>
) -> Self

A list of the Elastic Inference (EI) instance types associated 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 default_code_repository(self, input: impl Into<String>) -> Self

The Git repository associated 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 Amazon SageMaker Notebook Instances.

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

The Git repository associated 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 Amazon SageMaker Notebook Instances.

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

Appends an item to additional_code_repositories.

To override the contents of this collection use set_additional_code_repositories.

An array of up to three Git repositories associated 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 Amazon SageMaker Notebook Instances.

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

An array of up to three Git repositories associated 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 Amazon SageMaker Notebook Instances.

pub fn root_access(self, input: RootAccess) -> Self

Whether root access is enabled or disabled for users of the notebook instance.

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.

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 build(self) -> DescribeNotebookInstanceOutput

Consumes the builder and constructs a DescribeNotebookInstanceOutput

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=.

impl StructuralPartialEq for Builder