com.amazonaws.services.sagemaker.model

Class CreateNotebookInstanceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateNotebookInstanceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateNotebookInstanceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateNotebookInstanceRequest()

Method Summary

Modifier and Type	Method and Description
CreateNotebookInstanceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAcceleratorTypes() A list of Elastic Inference (EI) instance types to associate with this notebook instance.
List<String>	getAdditionalCodeRepositories() An array of up to three Git repositories to associate with the notebook instance.
String	getDefaultCodeRepository() A Git repository to associate with the notebook instance as its default code repository.
String	getDirectInternetAccess() Sets whether Amazon SageMaker provides internet access to the notebook instance.
String	getInstanceType() The type of ML compute instance to launch for the notebook instance.
String	getKmsKeyId() The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance.
String	getLifecycleConfigName() The name of a lifecycle configuration to associate with the notebook instance.
String	getNotebookInstanceName() The name of the new notebook instance.
String	getRoleArn() When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf.
String	getRootAccess() Whether root access is enabled or disabled for users of the notebook instance.
List<String>	getSecurityGroupIds() The VPC security group IDs, in the form sg-xxxxxxxx.
String	getSubnetId() The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
List<Tag>	getTags() A list of tags to associate with the notebook instance.
Integer	getVolumeSizeInGB() The size, in GB, of the ML storage volume to attach to the notebook instance.
int	hashCode()
void	setAcceleratorTypes(Collection<String> acceleratorTypes) A list of Elastic Inference (EI) instance types to associate with this notebook instance.
void	setAdditionalCodeRepositories(Collection<String> additionalCodeRepositories) An array of up to three Git repositories to associate with the notebook instance.
void	setDefaultCodeRepository(String defaultCodeRepository) A Git repository to associate with the notebook instance as its default code repository.
void	setDirectInternetAccess(String directInternetAccess) Sets whether Amazon SageMaker provides internet access to the notebook instance.
void	setInstanceType(String instanceType) The type of ML compute instance to launch for the notebook instance.
void	setKmsKeyId(String kmsKeyId) The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance.
void	setLifecycleConfigName(String lifecycleConfigName) The name of a lifecycle configuration to associate with the notebook instance.
void	setNotebookInstanceName(String notebookInstanceName) The name of the new notebook instance.
void	setRoleArn(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.
void	setRootAccess(String rootAccess) Whether root access is enabled or disabled for users of the notebook instance.
void	setSecurityGroupIds(Collection<String> securityGroupIds) The VPC security group IDs, in the form sg-xxxxxxxx.
void	setSubnetId(String subnetId) The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
void	setTags(Collection<Tag> tags) A list of tags to associate with the notebook instance.
void	setVolumeSizeInGB(Integer volumeSizeInGB) The size, in GB, of the ML storage volume to attach to the notebook instance.
String	toString() Returns a string representation of this object.
CreateNotebookInstanceRequest	withAcceleratorTypes(Collection<String> acceleratorTypes) A list of Elastic Inference (EI) instance types to associate with this notebook instance.
CreateNotebookInstanceRequest	withAcceleratorTypes(NotebookInstanceAcceleratorType... acceleratorTypes) A list of Elastic Inference (EI) instance types to associate with this notebook instance.
CreateNotebookInstanceRequest	withAcceleratorTypes(String... acceleratorTypes) A list of Elastic Inference (EI) instance types to associate with this notebook instance.
CreateNotebookInstanceRequest	withAdditionalCodeRepositories(Collection<String> additionalCodeRepositories) An array of up to three Git repositories to associate with the notebook instance.
CreateNotebookInstanceRequest	withAdditionalCodeRepositories(String... additionalCodeRepositories) An array of up to three Git repositories to associate with the notebook instance.
CreateNotebookInstanceRequest	withDefaultCodeRepository(String defaultCodeRepository) A Git repository to associate with the notebook instance as its default code repository.
CreateNotebookInstanceRequest	withDirectInternetAccess(DirectInternetAccess directInternetAccess) Sets whether Amazon SageMaker provides internet access to the notebook instance.
CreateNotebookInstanceRequest	withDirectInternetAccess(String directInternetAccess) Sets whether Amazon SageMaker provides internet access to the notebook instance.
CreateNotebookInstanceRequest	withInstanceType(InstanceType instanceType) The type of ML compute instance to launch for the notebook instance.
CreateNotebookInstanceRequest	withInstanceType(String instanceType) The type of ML compute instance to launch for the notebook instance.
CreateNotebookInstanceRequest	withKmsKeyId(String kmsKeyId) The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance.
CreateNotebookInstanceRequest	withLifecycleConfigName(String lifecycleConfigName) The name of a lifecycle configuration to associate with the notebook instance.
CreateNotebookInstanceRequest	withNotebookInstanceName(String notebookInstanceName) The name of the new notebook instance.
CreateNotebookInstanceRequest	withRoleArn(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.
CreateNotebookInstanceRequest	withRootAccess(RootAccess rootAccess) Whether root access is enabled or disabled for users of the notebook instance.
CreateNotebookInstanceRequest	withRootAccess(String rootAccess) Whether root access is enabled or disabled for users of the notebook instance.
CreateNotebookInstanceRequest	withSecurityGroupIds(Collection<String> securityGroupIds) The VPC security group IDs, in the form sg-xxxxxxxx.
CreateNotebookInstanceRequest	withSecurityGroupIds(String... securityGroupIds) The VPC security group IDs, in the form sg-xxxxxxxx.
CreateNotebookInstanceRequest	withSubnetId(String subnetId) The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
CreateNotebookInstanceRequest	withTags(Collection<Tag> tags) A list of tags to associate with the notebook instance.
CreateNotebookInstanceRequest	withTags(Tag... tags) A list of tags to associate with the notebook instance.
CreateNotebookInstanceRequest	withVolumeSizeInGB(Integer volumeSizeInGB) The size, in GB, of the ML storage volume to attach to the notebook instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateNotebookInstanceRequest

public CreateNotebookInstanceRequest()

Method Detail

setNotebookInstanceName

public void setNotebookInstanceName(String notebookInstanceName)

The name of the new notebook instance.

Parameters:

notebookInstanceName - The name of the new notebook instance.

getNotebookInstanceName

public String getNotebookInstanceName()

The name of the new notebook instance.

Returns:

The name of the new notebook instance.

withNotebookInstanceName

public CreateNotebookInstanceRequest withNotebookInstanceName(String notebookInstanceName)

The name of the new notebook instance.

Parameters:

notebookInstanceName - The name of the new notebook instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceType

public void setInstanceType(String instanceType)

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

Parameters:

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

See Also:

InstanceType

getInstanceType

public String getInstanceType()

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

Returns:

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

See Also:

InstanceType

withInstanceType

public CreateNotebookInstanceRequest withInstanceType(String instanceType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstanceType

withInstanceType

public CreateNotebookInstanceRequest withInstanceType(InstanceType instanceType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstanceType

setSubnetId

public void setSubnetId(String subnetId)

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

Parameters:

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

getSubnetId

public String getSubnetId()

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.

withSubnetId

public CreateNotebookInstanceRequest withSubnetId(String subnetId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getSecurityGroupIds

public List<String> getSecurityGroupIds()

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

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.

setSecurityGroupIds

public void setSecurityGroupIds(Collection<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.

Parameters:

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.

withSecurityGroupIds

public CreateNotebookInstanceRequest withSecurityGroupIds(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.

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSecurityGroupIds

public CreateNotebookInstanceRequest withSecurityGroupIds(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRoleArn

public void setRoleArn(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) permissionsto 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.

Parameters:

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) permissionsto 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.

getRoleArn

public String getRoleArn()

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) permissionsto 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) permissionsto 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.

withRoleArn

public CreateNotebookInstanceRequest withRoleArn(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) permissionsto 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.

Parameters:

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) permissionsto 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:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon 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 AWS Key Management Service Developer Guide.

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon 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 AWS Key Management Service Developer Guide.

getKmsKeyId

public String getKmsKeyId()

The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon 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 AWS Key Management Service Developer Guide.

Returns:

The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon 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 AWS Key Management Service Developer Guide.

withKmsKeyId

public CreateNotebookInstanceRequest withKmsKeyId(String kmsKeyId)

The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon 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 AWS Key Management Service Developer Guide.

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon 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 AWS Key Management Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

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

withTags

public CreateNotebookInstanceRequest withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateNotebookInstanceRequest withTags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLifecycleConfigName

public void setLifecycleConfigName(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.

Parameters:

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.

getLifecycleConfigName

public String getLifecycleConfigName()

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.

withLifecycleConfigName

public CreateNotebookInstanceRequest withLifecycleConfigName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDirectInternetAccess

public void setDirectInternetAccess(String 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.

Parameters:

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.

See Also:

DirectInternetAccess

getDirectInternetAccess

public String getDirectInternetAccess()

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.

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

withDirectInternetAccess

public CreateNotebookInstanceRequest withDirectInternetAccess(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DirectInternetAccess

withDirectInternetAccess

public CreateNotebookInstanceRequest withDirectInternetAccess(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DirectInternetAccess

setVolumeSizeInGB

public void setVolumeSizeInGB(Integer volumeSizeInGB)

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

Parameters:

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

getVolumeSizeInGB

public Integer getVolumeSizeInGB()

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.

withVolumeSizeInGB

public CreateNotebookInstanceRequest withVolumeSizeInGB(Integer volumeSizeInGB)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getAcceleratorTypes

public List<String> getAcceleratorTypes()

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.

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

See Also:

NotebookInstanceAcceleratorType

setAcceleratorTypes

public void setAcceleratorTypes(Collection<String> 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 instance. For more information, see Using Elastic Inference in Amazon SageMaker.

Parameters:

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

See Also:

NotebookInstanceAcceleratorType

withAcceleratorTypes

public CreateNotebookInstanceRequest withAcceleratorTypes(String... 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 instance. For more information, see Using Elastic Inference in Amazon SageMaker.

NOTE: This method appends the values to the existing list (if any). Use setAcceleratorTypes(java.util.Collection) or withAcceleratorTypes(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotebookInstanceAcceleratorType

withAcceleratorTypes

public CreateNotebookInstanceRequest withAcceleratorTypes(Collection<String> 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 instance. For more information, see Using Elastic Inference in Amazon SageMaker.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotebookInstanceAcceleratorType

withAcceleratorTypes

public CreateNotebookInstanceRequest withAcceleratorTypes(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 instance. For more information, see Using Elastic Inference in Amazon SageMaker.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotebookInstanceAcceleratorType

setDefaultCodeRepository

public void setDefaultCodeRepository(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.

Parameters:

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.

getDefaultCodeRepository

public String getDefaultCodeRepository()

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.

withDefaultCodeRepository

public CreateNotebookInstanceRequest withDefaultCodeRepository(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getAdditionalCodeRepositories

public List<String> getAdditionalCodeRepositories()

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

Returns:

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

setAdditionalCodeRepositories

public void setAdditionalCodeRepositories(Collection<String> additionalCodeRepositories)

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

Parameters:

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

withAdditionalCodeRepositories

public CreateNotebookInstanceRequest withAdditionalCodeRepositories(String... additionalCodeRepositories)

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

NOTE: This method appends the values to the existing list (if any). Use setAdditionalCodeRepositories(java.util.Collection) or withAdditionalCodeRepositories(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withAdditionalCodeRepositories

public CreateNotebookInstanceRequest withAdditionalCodeRepositories(Collection<String> additionalCodeRepositories)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setRootAccess

public void setRootAccess(String 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.

Parameters:

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.

See Also:

RootAccess

getRootAccess

public String getRootAccess()

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.

Returns:

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.

See Also:

RootAccess

withRootAccess

public CreateNotebookInstanceRequest withRootAccess(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RootAccess

withRootAccess

public CreateNotebookInstanceRequest withRootAccess(RootAccess 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RootAccess

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateNotebookInstanceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()