software.amazon.awssdk.services.sagemaker.model

Class CreateNotebookInstanceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateNotebookInstanceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateNotebookInstanceRequest.Builder,CreateNotebookInstanceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateNotebookInstanceRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateNotebookInstanceRequest.Builder,CreateNotebookInstanceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateNotebookInstanceRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<NotebookInstanceAcceleratorType>	acceleratorTypes() A list of Elastic Inference (EI) instance types to associate with this notebook instance.
List<String>	acceleratorTypesAsStrings() A list of Elastic Inference (EI) instance types to associate with this notebook instance.
List<String>	additionalCodeRepositories() An array of up to 3 git repositories to associate with the notebook instance.
static CreateNotebookInstanceRequest.Builder	builder()
String	defaultCodeRepository() A git repository to associate with the notebook instance as its default code repository.
DirectInternetAccess	directInternetAccess() Sets whether Amazon SageMaker provides internet access to the notebook instance.
String	directInternetAccessAsString() Sets whether Amazon SageMaker provides internet access to the notebook instance.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
InstanceType	instanceType() The type of ML compute instance to launch for the notebook instance.
String	instanceTypeAsString() The type of ML compute instance to launch for the notebook instance.
String	kmsKeyId() If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance.
String	lifecycleConfigName() The name of a lifecycle configuration to associate with the notebook instance.
String	notebookInstanceName() The name of the new notebook instance.
String	roleArn() When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds() The VPC security group IDs, in the form sg-xxxxxxxx.
static Class<? extends CreateNotebookInstanceRequest.Builder>	serializableBuilderClass()
String	subnetId() The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
List<Tag>	tags() A list of tags to associate with the notebook instance.
CreateNotebookInstanceRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	volumeSizeInGB() The size, in GB, of the ML storage volume to attach to the notebook instance.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

notebookInstanceName

public String notebookInstanceName()

The name of the new notebook instance.

Returns:

The name of the new notebook instance.

instanceType

public InstanceType instanceType()

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

If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

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

See Also:

InstanceType

instanceTypeAsString

public String instanceTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

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

See Also:

InstanceType

subnetId

public String subnetId()

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

Returns:

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

securityGroupIds

public List<String> securityGroupIds()

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

roleArn

public String roleArn()

When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see Amazon SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

Returns:

When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see Amazon SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

kmsKeyId

public String kmsKeyId()

If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance.

Returns:

If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance.

tags

public List<Tag> tags()

A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.

lifecycleConfigName

public String lifecycleConfigName()

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.

Returns:

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.

directInternetAccess

public DirectInternetAccess directInternetAccess()

Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your 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.

If the service returns an enum value that is not available in the current SDK version, directInternetAccess will return DirectInternetAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directInternetAccessAsString().

Returns:

Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your 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.

See Also:

DirectInternetAccess

directInternetAccessAsString

public String directInternetAccessAsString()

Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your 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.

If the service returns an enum value that is not available in the current SDK version, directInternetAccess will return DirectInternetAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directInternetAccessAsString().

Returns:

Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your 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.

See Also:

DirectInternetAccess

volumeSizeInGB

public Integer volumeSizeInGB()

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

Returns:

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

acceleratorTypes

public List<NotebookInstanceAcceleratorType> acceleratorTypes()

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 intance. For more information, see Using Elastic Inference in Amazon SageMaker.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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 intance. For more information, see Using Elastic Inference in Amazon SageMaker.

acceleratorTypesAsStrings

public List<String> acceleratorTypesAsStrings()

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 intance. For more information, see Using Elastic Inference in Amazon SageMaker.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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 intance. For more information, see Using Elastic Inference in Amazon SageMaker.

defaultCodeRepository

public String defaultCodeRepository()

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

Returns:

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

additionalCodeRepositories

public List<String> additionalCodeRepositories()

An array of up to 3 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 AWS 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

An array of up to 3 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 AWS 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.

toBuilder

public CreateNotebookInstanceRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateNotebookInstanceRequest.Builder,CreateNotebookInstanceRequest>

Specified by:

toBuilder in class SageMakerRequest

Returns:

a builder for type T

builder

public static CreateNotebookInstanceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateNotebookInstanceRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.