// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeNotebookInstanceOutput {
/// <p>The Amazon Resource Name (ARN) of the notebook instance.</p>
pub notebook_instance_arn: ::std::option::Option<::std::string::String>,
/// <p>The name of the SageMaker AI notebook instance.</p>
pub notebook_instance_name: ::std::option::Option<::std::string::String>,
/// <p>The status of the notebook instance.</p>
pub notebook_instance_status: ::std::option::Option<crate::types::NotebookInstanceStatus>,
/// <p>If status is <code>Failed</code>, the reason it failed.</p>
pub failure_reason: ::std::option::Option<::std::string::String>,
/// <p>The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.</p>
pub url: ::std::option::Option<::std::string::String>,
/// <p>The type of ML compute instance running on the notebook instance.</p>
pub instance_type: ::std::option::Option<crate::types::InstanceType>,
/// <p>The IP address type configured for the notebook instance. Returns <code>ipv4</code> for IPv4-only connectivity or <code>dualstack</code> for both IPv4 and IPv6 connectivity.</p>
pub ip_address_type: ::std::option::Option<crate::types::IpAddressType>,
/// <p>The ID of the VPC subnet.</p>
pub subnet_id: ::std::option::Option<::std::string::String>,
/// <p>The IDs of the VPC security groups.</p>
pub security_groups: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The Amazon Resource Name (ARN) of the IAM role associated with the instance.</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.</p>
pub kms_key_id: ::std::option::Option<::std::string::String>,
/// <p>The network interface IDs that SageMaker AI created at the time of creating the instance.</p>
pub network_interface_id: ::std::option::Option<::std::string::String>,
/// <p>A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.</p>
pub last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>A timestamp. Use this parameter to return the time when the notebook instance was created</p>
pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>Returns the name of a notebook instance lifecycle configuration.</p>
/// <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a></p>
pub notebook_instance_lifecycle_config_name: ::std::option::Option<::std::string::String>,
/// <p>Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to <i>Disabled</i>, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>.</p>
pub direct_internet_access: ::std::option::Option<crate::types::DirectInternetAccess>,
/// <p>The size, in GB, of the ML storage volume attached to the notebook instance.</p>
pub volume_size_in_gb: ::std::option::Option<i32>,
/// <p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p>
/// <p>This parameter was used to specify a list of the EI instance types associated with this notebook instance.</p>
pub accelerator_types: ::std::option::Option<::std::vec::Vec<crate::types::NotebookInstanceAcceleratorType>>,
/// <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
pub default_code_repository: ::std::option::Option<::std::string::String>,
/// <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
pub additional_code_repositories: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>Whether root access is enabled or disabled for users of the notebook instance.</p><note>
/// <p>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.</p>
/// </note>
pub root_access: ::std::option::Option<crate::types::RootAccess>,
/// <p>The platform identifier of the notebook instance runtime environment.</p>
pub platform_identifier: ::std::option::Option<::std::string::String>,
/// <p>Information on the IMDS configuration of the notebook instance</p>
pub instance_metadata_service_configuration: ::std::option::Option<crate::types::InstanceMetadataServiceConfiguration>,
_request_id: Option<String>,
}
impl DescribeNotebookInstanceOutput {
/// <p>The Amazon Resource Name (ARN) of the notebook instance.</p>
pub fn notebook_instance_arn(&self) -> ::std::option::Option<&str> {
self.notebook_instance_arn.as_deref()
}
/// <p>The name of the SageMaker AI notebook instance.</p>
pub fn notebook_instance_name(&self) -> ::std::option::Option<&str> {
self.notebook_instance_name.as_deref()
}
/// <p>The status of the notebook instance.</p>
pub fn notebook_instance_status(&self) -> ::std::option::Option<&crate::types::NotebookInstanceStatus> {
self.notebook_instance_status.as_ref()
}
/// <p>If status is <code>Failed</code>, the reason it failed.</p>
pub fn failure_reason(&self) -> ::std::option::Option<&str> {
self.failure_reason.as_deref()
}
/// <p>The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.</p>
pub fn url(&self) -> ::std::option::Option<&str> {
self.url.as_deref()
}
/// <p>The type of ML compute instance running on the notebook instance.</p>
pub fn instance_type(&self) -> ::std::option::Option<&crate::types::InstanceType> {
self.instance_type.as_ref()
}
/// <p>The IP address type configured for the notebook instance. Returns <code>ipv4</code> for IPv4-only connectivity or <code>dualstack</code> for both IPv4 and IPv6 connectivity.</p>
pub fn ip_address_type(&self) -> ::std::option::Option<&crate::types::IpAddressType> {
self.ip_address_type.as_ref()
}
/// <p>The ID of the VPC subnet.</p>
pub fn subnet_id(&self) -> ::std::option::Option<&str> {
self.subnet_id.as_deref()
}
/// <p>The IDs of the VPC security groups.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.security_groups.is_none()`.
pub fn security_groups(&self) -> &[::std::string::String] {
self.security_groups.as_deref().unwrap_or_default()
}
/// <p>The Amazon Resource Name (ARN) of the IAM role associated with the instance.</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.</p>
pub fn kms_key_id(&self) -> ::std::option::Option<&str> {
self.kms_key_id.as_deref()
}
/// <p>The network interface IDs that SageMaker AI created at the time of creating the instance.</p>
pub fn network_interface_id(&self) -> ::std::option::Option<&str> {
self.network_interface_id.as_deref()
}
/// <p>A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.</p>
pub fn last_modified_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.last_modified_time.as_ref()
}
/// <p>A timestamp. Use this parameter to return the time when the notebook instance was created</p>
pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.creation_time.as_ref()
}
/// <p>Returns the name of a notebook instance lifecycle configuration.</p>
/// <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a></p>
pub fn notebook_instance_lifecycle_config_name(&self) -> ::std::option::Option<&str> {
self.notebook_instance_lifecycle_config_name.as_deref()
}
/// <p>Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to <i>Disabled</i>, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>.</p>
pub fn direct_internet_access(&self) -> ::std::option::Option<&crate::types::DirectInternetAccess> {
self.direct_internet_access.as_ref()
}
/// <p>The size, in GB, of the ML storage volume attached to the notebook instance.</p>
pub fn volume_size_in_gb(&self) -> ::std::option::Option<i32> {
self.volume_size_in_gb
}
/// <p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p>
/// <p>This parameter was used to specify a list of the EI instance types associated with this notebook instance.</p>
///
/// 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()`.
pub fn accelerator_types(&self) -> &[crate::types::NotebookInstanceAcceleratorType] {
self.accelerator_types.as_deref().unwrap_or_default()
}
/// <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
pub fn default_code_repository(&self) -> ::std::option::Option<&str> {
self.default_code_repository.as_deref()
}
/// <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
///
/// 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()`.
pub fn additional_code_repositories(&self) -> &[::std::string::String] {
self.additional_code_repositories.as_deref().unwrap_or_default()
}
/// <p>Whether root access is enabled or disabled for users of the notebook instance.</p><note>
/// <p>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.</p>
/// </note>
pub fn root_access(&self) -> ::std::option::Option<&crate::types::RootAccess> {
self.root_access.as_ref()
}
/// <p>The platform identifier of the notebook instance runtime environment.</p>
pub fn platform_identifier(&self) -> ::std::option::Option<&str> {
self.platform_identifier.as_deref()
}
/// <p>Information on the IMDS configuration of the notebook instance</p>
pub fn instance_metadata_service_configuration(&self) -> ::std::option::Option<&crate::types::InstanceMetadataServiceConfiguration> {
self.instance_metadata_service_configuration.as_ref()
}
}
impl ::aws_types::request_id::RequestId for DescribeNotebookInstanceOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeNotebookInstanceOutput {
/// Creates a new builder-style object to manufacture [`DescribeNotebookInstanceOutput`](crate::operation::describe_notebook_instance::DescribeNotebookInstanceOutput).
pub fn builder() -> crate::operation::describe_notebook_instance::builders::DescribeNotebookInstanceOutputBuilder {
crate::operation::describe_notebook_instance::builders::DescribeNotebookInstanceOutputBuilder::default()
}
}
/// A builder for [`DescribeNotebookInstanceOutput`](crate::operation::describe_notebook_instance::DescribeNotebookInstanceOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeNotebookInstanceOutputBuilder {
pub(crate) notebook_instance_arn: ::std::option::Option<::std::string::String>,
pub(crate) notebook_instance_name: ::std::option::Option<::std::string::String>,
pub(crate) notebook_instance_status: ::std::option::Option<crate::types::NotebookInstanceStatus>,
pub(crate) failure_reason: ::std::option::Option<::std::string::String>,
pub(crate) url: ::std::option::Option<::std::string::String>,
pub(crate) instance_type: ::std::option::Option<crate::types::InstanceType>,
pub(crate) ip_address_type: ::std::option::Option<crate::types::IpAddressType>,
pub(crate) subnet_id: ::std::option::Option<::std::string::String>,
pub(crate) security_groups: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) kms_key_id: ::std::option::Option<::std::string::String>,
pub(crate) network_interface_id: ::std::option::Option<::std::string::String>,
pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) notebook_instance_lifecycle_config_name: ::std::option::Option<::std::string::String>,
pub(crate) direct_internet_access: ::std::option::Option<crate::types::DirectInternetAccess>,
pub(crate) volume_size_in_gb: ::std::option::Option<i32>,
pub(crate) accelerator_types: ::std::option::Option<::std::vec::Vec<crate::types::NotebookInstanceAcceleratorType>>,
pub(crate) default_code_repository: ::std::option::Option<::std::string::String>,
pub(crate) additional_code_repositories: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) root_access: ::std::option::Option<crate::types::RootAccess>,
pub(crate) platform_identifier: ::std::option::Option<::std::string::String>,
pub(crate) instance_metadata_service_configuration: ::std::option::Option<crate::types::InstanceMetadataServiceConfiguration>,
_request_id: Option<String>,
}
impl DescribeNotebookInstanceOutputBuilder {
/// <p>The Amazon Resource Name (ARN) of the notebook instance.</p>
pub fn notebook_instance_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.notebook_instance_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the notebook instance.</p>
pub fn set_notebook_instance_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.notebook_instance_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the notebook instance.</p>
pub fn get_notebook_instance_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.notebook_instance_arn
}
/// <p>The name of the SageMaker AI notebook instance.</p>
pub fn notebook_instance_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.notebook_instance_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the SageMaker AI notebook instance.</p>
pub fn set_notebook_instance_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.notebook_instance_name = input;
self
}
/// <p>The name of the SageMaker AI notebook instance.</p>
pub fn get_notebook_instance_name(&self) -> &::std::option::Option<::std::string::String> {
&self.notebook_instance_name
}
/// <p>The status of the notebook instance.</p>
pub fn notebook_instance_status(mut self, input: crate::types::NotebookInstanceStatus) -> Self {
self.notebook_instance_status = ::std::option::Option::Some(input);
self
}
/// <p>The status of the notebook instance.</p>
pub fn set_notebook_instance_status(mut self, input: ::std::option::Option<crate::types::NotebookInstanceStatus>) -> Self {
self.notebook_instance_status = input;
self
}
/// <p>The status of the notebook instance.</p>
pub fn get_notebook_instance_status(&self) -> &::std::option::Option<crate::types::NotebookInstanceStatus> {
&self.notebook_instance_status
}
/// <p>If status is <code>Failed</code>, the reason it failed.</p>
pub fn failure_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.failure_reason = ::std::option::Option::Some(input.into());
self
}
/// <p>If status is <code>Failed</code>, the reason it failed.</p>
pub fn set_failure_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.failure_reason = input;
self
}
/// <p>If status is <code>Failed</code>, the reason it failed.</p>
pub fn get_failure_reason(&self) -> &::std::option::Option<::std::string::String> {
&self.failure_reason
}
/// <p>The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.</p>
pub fn url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.url = ::std::option::Option::Some(input.into());
self
}
/// <p>The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.</p>
pub fn set_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.url = input;
self
}
/// <p>The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.</p>
pub fn get_url(&self) -> &::std::option::Option<::std::string::String> {
&self.url
}
/// <p>The type of ML compute instance running on the notebook instance.</p>
pub fn instance_type(mut self, input: crate::types::InstanceType) -> Self {
self.instance_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of ML compute instance running on the notebook instance.</p>
pub fn set_instance_type(mut self, input: ::std::option::Option<crate::types::InstanceType>) -> Self {
self.instance_type = input;
self
}
/// <p>The type of ML compute instance running on the notebook instance.</p>
pub fn get_instance_type(&self) -> &::std::option::Option<crate::types::InstanceType> {
&self.instance_type
}
/// <p>The IP address type configured for the notebook instance. Returns <code>ipv4</code> for IPv4-only connectivity or <code>dualstack</code> for both IPv4 and IPv6 connectivity.</p>
pub fn ip_address_type(mut self, input: crate::types::IpAddressType) -> Self {
self.ip_address_type = ::std::option::Option::Some(input);
self
}
/// <p>The IP address type configured for the notebook instance. Returns <code>ipv4</code> for IPv4-only connectivity or <code>dualstack</code> for both IPv4 and IPv6 connectivity.</p>
pub fn set_ip_address_type(mut self, input: ::std::option::Option<crate::types::IpAddressType>) -> Self {
self.ip_address_type = input;
self
}
/// <p>The IP address type configured for the notebook instance. Returns <code>ipv4</code> for IPv4-only connectivity or <code>dualstack</code> for both IPv4 and IPv6 connectivity.</p>
pub fn get_ip_address_type(&self) -> &::std::option::Option<crate::types::IpAddressType> {
&self.ip_address_type
}
/// <p>The ID of the VPC subnet.</p>
pub fn subnet_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.subnet_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the VPC subnet.</p>
pub fn set_subnet_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.subnet_id = input;
self
}
/// <p>The ID of the VPC subnet.</p>
pub fn get_subnet_id(&self) -> &::std::option::Option<::std::string::String> {
&self.subnet_id
}
/// Appends an item to `security_groups`.
///
/// To override the contents of this collection use [`set_security_groups`](Self::set_security_groups).
///
/// <p>The IDs of the VPC security groups.</p>
pub fn security_groups(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.security_groups.unwrap_or_default();
v.push(input.into());
self.security_groups = ::std::option::Option::Some(v);
self
}
/// <p>The IDs of the VPC security groups.</p>
pub fn set_security_groups(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.security_groups = input;
self
}
/// <p>The IDs of the VPC security groups.</p>
pub fn get_security_groups(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.security_groups
}
/// <p>The Amazon Resource Name (ARN) of the IAM role associated with the instance.</p>
pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role associated with the instance.</p>
pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.role_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role associated with the instance.</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// <p>The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.</p>
pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.kms_key_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.</p>
pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.kms_key_id = input;
self
}
/// <p>The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.</p>
pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
&self.kms_key_id
}
/// <p>The network interface IDs that SageMaker AI created at the time of creating the instance.</p>
pub fn network_interface_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.network_interface_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The network interface IDs that SageMaker AI created at the time of creating the instance.</p>
pub fn set_network_interface_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.network_interface_id = input;
self
}
/// <p>The network interface IDs that SageMaker AI created at the time of creating the instance.</p>
pub fn get_network_interface_id(&self) -> &::std::option::Option<::std::string::String> {
&self.network_interface_id
}
/// <p>A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.</p>
pub fn last_modified_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.last_modified_time = ::std::option::Option::Some(input);
self
}
/// <p>A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.</p>
pub fn set_last_modified_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.last_modified_time = input;
self
}
/// <p>A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.</p>
pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.last_modified_time
}
/// <p>A timestamp. Use this parameter to return the time when the notebook instance was created</p>
pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.creation_time = ::std::option::Option::Some(input);
self
}
/// <p>A timestamp. Use this parameter to return the time when the notebook instance was created</p>
pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.creation_time = input;
self
}
/// <p>A timestamp. Use this parameter to return the time when the notebook instance was created</p>
pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.creation_time
}
/// <p>Returns the name of a notebook instance lifecycle configuration.</p>
/// <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a></p>
pub fn notebook_instance_lifecycle_config_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.notebook_instance_lifecycle_config_name = ::std::option::Option::Some(input.into());
self
}
/// <p>Returns the name of a notebook instance lifecycle configuration.</p>
/// <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a></p>
pub fn set_notebook_instance_lifecycle_config_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.notebook_instance_lifecycle_config_name = input;
self
}
/// <p>Returns the name of a notebook instance lifecycle configuration.</p>
/// <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a></p>
pub fn get_notebook_instance_lifecycle_config_name(&self) -> &::std::option::Option<::std::string::String> {
&self.notebook_instance_lifecycle_config_name
}
/// <p>Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to <i>Disabled</i>, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>.</p>
pub fn direct_internet_access(mut self, input: crate::types::DirectInternetAccess) -> Self {
self.direct_internet_access = ::std::option::Option::Some(input);
self
}
/// <p>Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to <i>Disabled</i>, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>.</p>
pub fn set_direct_internet_access(mut self, input: ::std::option::Option<crate::types::DirectInternetAccess>) -> Self {
self.direct_internet_access = input;
self
}
/// <p>Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to <i>Disabled</i>, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>.</p>
pub fn get_direct_internet_access(&self) -> &::std::option::Option<crate::types::DirectInternetAccess> {
&self.direct_internet_access
}
/// <p>The size, in GB, of the ML storage volume attached to the notebook instance.</p>
pub fn volume_size_in_gb(mut self, input: i32) -> Self {
self.volume_size_in_gb = ::std::option::Option::Some(input);
self
}
/// <p>The size, in GB, of the ML storage volume attached to the notebook instance.</p>
pub fn set_volume_size_in_gb(mut self, input: ::std::option::Option<i32>) -> Self {
self.volume_size_in_gb = input;
self
}
/// <p>The size, in GB, of the ML storage volume attached to the notebook instance.</p>
pub fn get_volume_size_in_gb(&self) -> &::std::option::Option<i32> {
&self.volume_size_in_gb
}
/// Appends an item to `accelerator_types`.
///
/// To override the contents of this collection use [`set_accelerator_types`](Self::set_accelerator_types).
///
/// <p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p>
/// <p>This parameter was used to specify a list of the EI instance types associated with this notebook instance.</p>
pub fn accelerator_types(mut self, input: crate::types::NotebookInstanceAcceleratorType) -> Self {
let mut v = self.accelerator_types.unwrap_or_default();
v.push(input);
self.accelerator_types = ::std::option::Option::Some(v);
self
}
/// <p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p>
/// <p>This parameter was used to specify a list of the EI instance types associated with this notebook instance.</p>
pub fn set_accelerator_types(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::NotebookInstanceAcceleratorType>>) -> Self {
self.accelerator_types = input;
self
}
/// <p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p>
/// <p>This parameter was used to specify a list of the EI instance types associated with this notebook instance.</p>
pub fn get_accelerator_types(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::NotebookInstanceAcceleratorType>> {
&self.accelerator_types
}
/// <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
pub fn default_code_repository(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.default_code_repository = ::std::option::Option::Some(input.into());
self
}
/// <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
pub fn set_default_code_repository(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.default_code_repository = input;
self
}
/// <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
pub fn get_default_code_repository(&self) -> &::std::option::Option<::std::string::String> {
&self.default_code_repository
}
/// Appends an item to `additional_code_repositories`.
///
/// To override the contents of this collection use [`set_additional_code_repositories`](Self::set_additional_code_repositories).
///
/// <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
pub fn additional_code_repositories(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.additional_code_repositories.unwrap_or_default();
v.push(input.into());
self.additional_code_repositories = ::std::option::Option::Some(v);
self
}
/// <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
pub fn set_additional_code_repositories(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.additional_code_repositories = input;
self
}
/// <p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>
pub fn get_additional_code_repositories(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.additional_code_repositories
}
/// <p>Whether root access is enabled or disabled for users of the notebook instance.</p><note>
/// <p>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.</p>
/// </note>
pub fn root_access(mut self, input: crate::types::RootAccess) -> Self {
self.root_access = ::std::option::Option::Some(input);
self
}
/// <p>Whether root access is enabled or disabled for users of the notebook instance.</p><note>
/// <p>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.</p>
/// </note>
pub fn set_root_access(mut self, input: ::std::option::Option<crate::types::RootAccess>) -> Self {
self.root_access = input;
self
}
/// <p>Whether root access is enabled or disabled for users of the notebook instance.</p><note>
/// <p>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.</p>
/// </note>
pub fn get_root_access(&self) -> &::std::option::Option<crate::types::RootAccess> {
&self.root_access
}
/// <p>The platform identifier of the notebook instance runtime environment.</p>
pub fn platform_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.platform_identifier = ::std::option::Option::Some(input.into());
self
}
/// <p>The platform identifier of the notebook instance runtime environment.</p>
pub fn set_platform_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.platform_identifier = input;
self
}
/// <p>The platform identifier of the notebook instance runtime environment.</p>
pub fn get_platform_identifier(&self) -> &::std::option::Option<::std::string::String> {
&self.platform_identifier
}
/// <p>Information on the IMDS configuration of the notebook instance</p>
pub fn instance_metadata_service_configuration(mut self, input: crate::types::InstanceMetadataServiceConfiguration) -> Self {
self.instance_metadata_service_configuration = ::std::option::Option::Some(input);
self
}
/// <p>Information on the IMDS configuration of the notebook instance</p>
pub fn set_instance_metadata_service_configuration(
mut self,
input: ::std::option::Option<crate::types::InstanceMetadataServiceConfiguration>,
) -> Self {
self.instance_metadata_service_configuration = input;
self
}
/// <p>Information on the IMDS configuration of the notebook instance</p>
pub fn get_instance_metadata_service_configuration(&self) -> &::std::option::Option<crate::types::InstanceMetadataServiceConfiguration> {
&self.instance_metadata_service_configuration
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`DescribeNotebookInstanceOutput`](crate::operation::describe_notebook_instance::DescribeNotebookInstanceOutput).
pub fn build(self) -> crate::operation::describe_notebook_instance::DescribeNotebookInstanceOutput {
crate::operation::describe_notebook_instance::DescribeNotebookInstanceOutput {
notebook_instance_arn: self.notebook_instance_arn,
notebook_instance_name: self.notebook_instance_name,
notebook_instance_status: self.notebook_instance_status,
failure_reason: self.failure_reason,
url: self.url,
instance_type: self.instance_type,
ip_address_type: self.ip_address_type,
subnet_id: self.subnet_id,
security_groups: self.security_groups,
role_arn: self.role_arn,
kms_key_id: self.kms_key_id,
network_interface_id: self.network_interface_id,
last_modified_time: self.last_modified_time,
creation_time: self.creation_time,
notebook_instance_lifecycle_config_name: self.notebook_instance_lifecycle_config_name,
direct_internet_access: self.direct_internet_access,
volume_size_in_gb: self.volume_size_in_gb,
accelerator_types: self.accelerator_types,
default_code_repository: self.default_code_repository,
additional_code_repositories: self.additional_code_repositories,
root_access: self.root_access,
platform_identifier: self.platform_identifier,
instance_metadata_service_configuration: self.instance_metadata_service_configuration,
_request_id: self._request_id,
}
}
}