AwsSageMakerNotebookInstanceDetails (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.securityhub.model.AwsSageMakerNotebookInstanceDetails

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AwsSageMakerNotebookInstanceDetails.Builder,AwsSageMakerNotebookInstanceDetails>

@Generated(value="software.amazon.awssdk:codegen")
public final class AwsSageMakerNotebookInstanceDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsSageMakerNotebookInstanceDetails.Builder,AwsSageMakerNotebookInstanceDetails>

Provides details about an Amazon SageMaker notebook instance.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AwsSageMakerNotebookInstanceDetails.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AwsSageMakerNotebookInstanceDetails.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`acceleratorTypes()` A list of Amazon Elastic Inference instance types to associate with the notebook instance.
`List<String>`	`additionalCodeRepositories()` An array of up to three Git repositories associated with the notebook instance.
`static AwsSageMakerNotebookInstanceDetails.Builder`	`builder()`
`String`	`defaultCodeRepository()` The Git repository associated with the notebook instance as its default code repository.
`String`	`directInternetAccess()` Sets whether SageMaker provides internet access to the notebook instance.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` If status of the instance is `Failed`, the reason it failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAcceleratorTypes()` For responses, this returns true if the service returned a value for the AcceleratorTypes property.
`boolean`	`hasAdditionalCodeRepositories()` For responses, this returns true if the service returned a value for the AdditionalCodeRepositories property.
`int`	`hashCode()`
`boolean`	`hasSecurityGroups()` For responses, this returns true if the service returned a value for the SecurityGroups property.
`AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails`	`instanceMetadataServiceConfiguration()` Information on the IMDS configuration of the notebook instance.
`String`	`instanceType()` The type of machine learning (ML) compute instance to launch for the notebook instance.
`String`	`kmsKeyId()` 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.
`String`	`networkInterfaceId()` The network interface ID that SageMaker created when the instance was created.
`String`	`notebookInstanceArn()` The Amazon Resource Name (ARN) of the notebook instance.
`String`	`notebookInstanceLifecycleConfigName()` The name of a notebook instance lifecycle configuration.
`String`	`notebookInstanceName()` The name of the new notebook instance.
`String`	`notebookInstanceStatus()` The status of the notebook instance.
`String`	`platformIdentifier()` The platform identifier of the notebook instance runtime environment.
`String`	`roleArn()` The Amazon Resource Name (ARN) of the IAM role associated with the instance.
`String`	`rootAccess()` Whether root access is enabled or disabled for users of the notebook instance.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()` The VPC security group IDs.
`static Class<? extends AwsSageMakerNotebookInstanceDetails.Builder>`	`serializableBuilderClass()`
`String`	`subnetId()` The ID of the VPC subnet to which you have a connectivity from your ML compute instance.
`AwsSageMakerNotebookInstanceDetails.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`url()` The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
`Integer`	`volumeSizeInGB()` The size, in GB, of the ML storage volume to attach to the notebook instance.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasAcceleratorTypes
```
public final boolean hasAcceleratorTypes()
```
    For responses, this returns true if the service returned a value for the AcceleratorTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - acceleratorTypes
```
public final List<String> acceleratorTypes()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorTypes() method.
    
    Returns:
    
    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.
  - hasAdditionalCodeRepositories
```
public final boolean hasAdditionalCodeRepositories()
```
    For responses, this returns true if the service returned a value for the AdditionalCodeRepositories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - additionalCodeRepositories
```
public final List<String> additionalCodeRepositories()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalCodeRepositories() method.
    
    Returns:
    
    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.
  - defaultCodeRepository
```
public final String defaultCodeRepository()
```
    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.
    
    Returns:
    
    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.
  - directInternetAccess
```
public final String 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 Network Address Translation (NAT) Gateway in your VPC.
    
    Returns:
    
    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.
  - failureReason
```
public final String failureReason()
```
    If status of the instance is Failed, the reason it failed.
    
    Returns:
    
    If status of the instance is Failed, the reason it failed.
  - instanceMetadataServiceConfiguration
```
public final AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails instanceMetadataServiceConfiguration()
```
    Information on the IMDS configuration of the notebook instance.
    
    Returns:
    
    Information on the IMDS configuration of the notebook instance.
  - instanceType
```
public final String instanceType()
```
    The type of machine learning (ML) compute instance to launch for the notebook instance.
    
    Returns:
    
    The type of machine learning (ML) compute instance to launch for the notebook instance.
  - kmsKeyId
```
public final String kmsKeyId()
```
    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.
    
    Returns:
    
    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.
  - networkInterfaceId
```
public final String networkInterfaceId()
```
    The network interface ID that SageMaker created when the instance was created.
    
    Returns:
    
    The network interface ID that SageMaker created when the instance was created.
  - notebookInstanceArn
```
public final String notebookInstanceArn()
```
    The Amazon Resource Name (ARN) of the notebook instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the notebook instance.
  - notebookInstanceLifecycleConfigName
```
public final String notebookInstanceLifecycleConfigName()
```
    The name of a notebook instance lifecycle configuration.
    
    Returns:
    
    The name of a notebook instance lifecycle configuration.
  - notebookInstanceName
```
public final String notebookInstanceName()
```
    The name of the new notebook instance.
    
    Returns:
    
    The name of the new notebook instance.
  - notebookInstanceStatus
```
public final String notebookInstanceStatus()
```
    The status of the notebook instance.
    
    Returns:
    
    The status of the notebook instance.
  - platformIdentifier
```
public final String platformIdentifier()
```
    The platform identifier of the notebook instance runtime environment.
    
    Returns:
    
    The platform identifier of the notebook instance runtime environment.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of the IAM role associated with the instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role associated with the instance.
  - rootAccess
```
public final String rootAccess()
```
    Whether root access is enabled or disabled for users of the notebook instance.
    
    Returns:
    
    Whether root access is enabled or disabled for users of the notebook instance.
  - hasSecurityGroups
```
public final boolean hasSecurityGroups()
```
    For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - securityGroups
```
public final List<String> securityGroups()
```
    The VPC security group IDs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.
    
    Returns:
    
    The VPC security group IDs.
  - subnetId
```
public final String subnetId()
```
    The ID of the VPC subnet to which you have a connectivity from your ML compute instance.
    
    Returns:
    
    The ID of the VPC subnet to which you have a connectivity from your ML compute instance.
  - url
```
public final String url()
```
    The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
    
    Returns:
    
    The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
  - volumeSizeInGB
```
public final Integer volumeSizeInGB()
```
    The size, in GB, of the ML storage volume to attach to the notebook instance.
    
    Returns:
    
    The size, in GB, of the ML storage volume to attach to the notebook instance.
  - toBuilder
```
public AwsSageMakerNotebookInstanceDetails.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AwsSageMakerNotebookInstanceDetails.Builder,AwsSageMakerNotebookInstanceDetails>
  - builder
```
public static AwsSageMakerNotebookInstanceDetails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AwsSageMakerNotebookInstanceDetails.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AwsSageMakerNotebookInstanceDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAcceleratorTypes

acceleratorTypes

hasAdditionalCodeRepositories

additionalCodeRepositories

defaultCodeRepository

directInternetAccess

failureReason

instanceMetadataServiceConfiguration

instanceType

kmsKeyId

networkInterfaceId

notebookInstanceArn

notebookInstanceLifecycleConfigName

notebookInstanceName

notebookInstanceStatus

platformIdentifier

roleArn

rootAccess

hasSecurityGroups

securityGroups

subnetId

url

volumeSizeInGB

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields