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)
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() 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	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.
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.
int	hashCode()
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) 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.
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	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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
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) 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.
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	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.

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

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

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

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

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

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

setKmsKeyId

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

Parameters:

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.

getKmsKeyId

public String getKmsKeyId()

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.

withKmsKeyId

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

Parameters:

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:

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 notebook-lifecycle-config.

Parameters:

lifecycleConfigName - The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see notebook-lifecycle-config.

getLifecycleConfigName

public String getLifecycleConfigName()

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see notebook-lifecycle-config.

Returns:

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see notebook-lifecycle-config.

withLifecycleConfigName

public CreateNotebookInstanceRequest withLifecycleConfigName(String lifecycleConfigName)

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see notebook-lifecycle-config.

Parameters:

lifecycleConfigName - The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see notebook-lifecycle-config.

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 appendix-notebook-and-internet-access. 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 appendix-notebook-and-internet-access. 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 appendix-notebook-and-internet-access. 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 appendix-notebook-and-internet-access. 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 appendix-notebook-and-internet-access. 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 appendix-notebook-and-internet-access. 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 appendix-notebook-and-internet-access. 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 appendix-notebook-and-internet-access. 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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

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()