Struct aws_sdk_sagemaker::operation::create_notebook_instance::builders::CreateNotebookInstanceInputBuilder

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

A builder for CreateNotebookInstanceInput.

Implementations

impl CreateNotebookInstanceInputBuilder

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

The name of the new notebook instance.

This field is required.

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

The name of the new notebook instance.

pub fn get_notebook_instance_name(&self) -> &Option<String>

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.

This field is required.

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

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

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

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 get_subnet_id(&self) -> &Option<String>

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

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 get_security_group_ids(&self) -> &Option<Vec<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.

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.

This field is required.

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 get_role_arn(&self) -> &Option<String>

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 get_kms_key_id(&self) -> &Option<String>

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 get_tags(&self) -> &Option<Vec<Tag>>

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 get_lifecycle_config_name(&self) -> &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.

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

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

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 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 get_accelerator_types( &self, ) -> &Option<Vec<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.

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 get_default_code_repository(&self) -> &Option<String>

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

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 get_additional_code_repositories(&self) -> &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.

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

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 get_platform_identifier(&self) -> &Option<String>

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

pub fn get_instance_metadata_service_configuration( &self, ) -> &Option<InstanceMetadataServiceConfiguration>

Information on the IMDS configuration of the notebook instance

pub fn build(self) -> Result<CreateNotebookInstanceInput, BuildError>

Consumes the builder and constructs a CreateNotebookInstanceInput.

impl CreateNotebookInstanceInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<CreateNotebookInstanceOutput, SdkError<CreateNotebookInstanceError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateNotebookInstanceInputBuilder

fn clone(&self) -> CreateNotebookInstanceInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateNotebookInstanceInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateNotebookInstanceInputBuilder

fn default() -> CreateNotebookInstanceInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateNotebookInstanceInputBuilder

fn eq(&self, other: &CreateNotebookInstanceInputBuilder) -> 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 CreateNotebookInstanceInputBuilder