Struct aws_sdk_securityhub::types::AwsSageMakerNotebookInstanceDetails

#[non_exhaustive]
pub struct AwsSageMakerNotebookInstanceDetails {

    pub accelerator_types: Option<Vec<String>>,
    pub additional_code_repositories: Option<Vec<String>>,
    pub default_code_repository: Option<String>,
    pub direct_internet_access: Option<String>,
    pub failure_reason: Option<String>,
    pub instance_metadata_service_configuration: Option<AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails>,
    pub instance_type: Option<String>,
    pub kms_key_id: Option<String>,
    pub network_interface_id: Option<String>,
    pub notebook_instance_arn: Option<String>,
    pub notebook_instance_lifecycle_config_name: Option<String>,
    pub notebook_instance_name: Option<String>,
    pub notebook_instance_status: Option<String>,
    pub platform_identifier: Option<String>,
    pub role_arn: Option<String>,
    pub root_access: Option<String>,
    pub security_groups: Option<Vec<String>>,
    pub subnet_id: Option<String>,
    pub url: Option<String>,
    pub volume_size_in_gb: Option<i32>,
}

Provides details about an Amazon SageMaker notebook instance.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

accelerator_types: Option<Vec<String>>

A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.

additional_code_repositories: Option<Vec<String>>

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 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 in the Amazon SageMaker Developer Guide.

default_code_repository: Option<String>

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 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 in the Amazon SageMaker Developer Guide.

direct_internet_access: Option<String>

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 Network Address Translation (NAT) Gateway in your VPC.

failure_reason: Option<String>

If status of the instance is Failed, the reason it failed.

instance_metadata_service_configuration: Option<AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails>

Information on the IMDS configuration of the notebook instance.

instance_type: Option<String>

The type of machine learning (ML) compute instance to launch for the notebook instance.

kms_key_id: Option<String>

The Amazon Resource Name (ARN) of an Key Management Service (KMS) 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 Key Management Service Developer Guide.

network_interface_id: Option<String>

The network interface ID that SageMaker created when the instance was created.

notebook_instance_arn: Option<String>

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

notebook_instance_lifecycle_config_name: Option<String>

The name of a notebook instance lifecycle configuration.

notebook_instance_name: Option<String>

The name of the new notebook instance.

notebook_instance_status: Option<String>

The status of the notebook instance.

platform_identifier: Option<String>

The platform identifier of the notebook instance runtime environment.

role_arn: Option<String>

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

root_access: Option<String>

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

security_groups: Option<Vec<String>>

The VPC security group IDs.

subnet_id: Option<String>

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

url: Option<String>

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

volume_size_in_gb: Option<i32>

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

Implementations

impl AwsSageMakerNotebookInstanceDetails

pub fn accelerator_types(&self) -> &[String]

A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.

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 additional_code_repositories(&self) -> &[String]

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 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 in the Amazon SageMaker Developer Guide.

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 default_code_repository(&self) -> Option<&str>

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 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 in the Amazon SageMaker Developer Guide.

pub fn direct_internet_access(&self) -> Option<&str>

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 Network Address Translation (NAT) Gateway in your VPC.

pub fn failure_reason(&self) -> Option<&str>

If status of the instance is Failed, the reason it failed.

pub fn instance_metadata_service_configuration( &self ) -> Option<&AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails>

Information on the IMDS configuration of the notebook instance.

pub fn instance_type(&self) -> Option<&str>

The type of machine learning (ML) compute instance to launch for the notebook instance.

pub fn kms_key_id(&self) -> Option<&str>

The Amazon Resource Name (ARN) of an Key Management Service (KMS) 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 Key Management Service Developer Guide.

pub fn network_interface_id(&self) -> Option<&str>

The network interface ID that SageMaker created when the instance was created.

pub fn notebook_instance_arn(&self) -> Option<&str>

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

pub fn notebook_instance_lifecycle_config_name(&self) -> Option<&str>

The name of a notebook instance lifecycle configuration.

pub fn notebook_instance_name(&self) -> Option<&str>

The name of the new notebook instance.

pub fn notebook_instance_status(&self) -> Option<&str>

The status of the notebook instance.

pub fn platform_identifier(&self) -> Option<&str>

The platform identifier of the notebook instance runtime environment.

pub fn role_arn(&self) -> Option<&str>

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

pub fn root_access(&self) -> Option<&str>

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

pub fn security_groups(&self) -> &[String]

The VPC security group IDs.

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 subnet_id(&self) -> Option<&str>

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

pub fn url(&self) -> Option<&str>

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

pub fn volume_size_in_gb(&self) -> Option<i32>

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

impl AwsSageMakerNotebookInstanceDetails

pub fn builder() -> AwsSageMakerNotebookInstanceDetailsBuilder

Creates a new builder-style object to manufacture AwsSageMakerNotebookInstanceDetails.

Trait Implementations

impl Clone for AwsSageMakerNotebookInstanceDetails

fn clone(&self) -> AwsSageMakerNotebookInstanceDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AwsSageMakerNotebookInstanceDetails

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

Formats the value using the given formatter.

impl PartialEq for AwsSageMakerNotebookInstanceDetails

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