Class CreateNotebookInstanceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateNotebookInstanceRequest.Builder,
CreateNotebookInstanceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA list of Elastic Inference (EI) instance types to associate with this notebook instance.A list of Elastic Inference (EI) instance types to associate with this notebook instance.An array of up to three Git repositories to associate with the notebook instance.builder()
final String
A Git repository to associate with the notebook instance as its default code repository.final DirectInternetAccess
Sets whether SageMaker provides internet access to the notebook instance.final String
Sets whether SageMaker provides internet access to the notebook instance.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AcceleratorTypes property.final boolean
For responses, this returns true if the service returned a value for the AdditionalCodeRepositories property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecurityGroupIds property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Information on the IMDS configuration of the notebook instancefinal InstanceType
The type of ML compute instance to launch for the notebook instance.final String
The type of ML compute instance to launch for the notebook instance.final String
kmsKeyId()
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance.final String
The name of a lifecycle configuration to associate with the notebook instance.final String
The name of the new notebook instance.final String
The platform identifier of the notebook instance runtime environment.final String
roleArn()
When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.final RootAccess
Whether root access is enabled or disabled for users of the notebook instance.final String
Whether root access is enabled or disabled for users of the notebook instance.The VPC security group IDs, in the form sg-xxxxxxxx.static Class
<? extends CreateNotebookInstanceRequest.Builder> final String
subnetId()
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.tags()
An array of key-value pairs.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
notebookInstanceName
The name of the new notebook instance.
- Returns:
- The name of the new notebook instance.
-
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 returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The type of ML compute instance to launch for the notebook instance.
- See Also:
-
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 returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The type of ML compute instance to launch for the notebook instance.
- See Also:
-
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.
-
hasSecurityGroupIds
public final boolean hasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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
hasSecurityGroupIds()
method.- 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
When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles.
To be able to pass this role to SageMaker, the caller of this API must have the
iam:PassRole
permission.- Returns:
- When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes
this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker
can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com)
permissions to assume this role. For more information, see SageMaker Roles.
To be able to pass this role to SageMaker, the caller of this API must have the
iam:PassRole
permission.
-
kmsKeyId
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service 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 Amazon Web Services Key Management Service Developer Guide.
- Returns:
- The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service 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 Amazon Web Services Key Management Service Developer Guide.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
tags
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
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
hasTags()
method.- Returns:
- An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
-
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
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 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 theSubnetId
parameter.If the service returns an enum value that is not available in the current SDK version,
directInternetAccess
will returnDirectInternetAccess.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectInternetAccessAsString()
.- 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 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 theSubnetId
parameter. - See Also:
-
directInternetAccessAsString
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 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 theSubnetId
parameter.If the service returns an enum value that is not available in the current SDK version,
directInternetAccess
will returnDirectInternetAccess.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectInternetAccessAsString()
.- 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 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 theSubnetId
parameter. - See Also:
-
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
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.
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 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.
-
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 theisEmpty()
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. -
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 instance. For more information, see Using Elastic Inference in Amazon SageMaker.
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 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.
-
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 Amazon Web Services 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.
- 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 Amazon Web Services 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.
-
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 theisEmpty()
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
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 Amazon Web Services 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.
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 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 Amazon Web Services 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.
-
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.
If the service returns an enum value that is not available in the current SDK version,
rootAccess
will returnRootAccess.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrootAccessAsString()
.- 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:
-
rootAccessAsString
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.
If the service returns an enum value that is not available in the current SDK version,
rootAccess
will returnRootAccess.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrootAccessAsString()
.- 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:
-
platformIdentifier
The platform identifier of the notebook instance runtime environment.
- Returns:
- The platform identifier of the notebook instance runtime environment.
-
instanceMetadataServiceConfiguration
Information on the IMDS configuration of the notebook instance
- Returns:
- Information on the IMDS configuration of the notebook instance
-
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 interfaceToCopyableBuilder<CreateNotebookInstanceRequest.Builder,
CreateNotebookInstanceRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-