public static interface CreateNotebookInstanceRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateNotebookInstanceRequest.Builder,CreateNotebookInstanceRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateNotebookInstanceRequest.Builder |
acceleratorTypes(Collection<NotebookInstanceAcceleratorType> acceleratorTypes)
A list of Elastic Inference (EI) instance types to associate with this notebook instance.
|
CreateNotebookInstanceRequest.Builder |
acceleratorTypes(NotebookInstanceAcceleratorType... acceleratorTypes)
A list of Elastic Inference (EI) instance types to associate with this notebook instance.
|
CreateNotebookInstanceRequest.Builder |
acceleratorTypesWithStrings(Collection<String> acceleratorTypes)
A list of Elastic Inference (EI) instance types to associate with this notebook instance.
|
CreateNotebookInstanceRequest.Builder |
acceleratorTypesWithStrings(String... acceleratorTypes)
A list of Elastic Inference (EI) instance types to associate with this notebook instance.
|
CreateNotebookInstanceRequest.Builder |
additionalCodeRepositories(Collection<String> additionalCodeRepositories)
An array of up to three Git repositories to associate with the notebook instance.
|
CreateNotebookInstanceRequest.Builder |
additionalCodeRepositories(String... additionalCodeRepositories)
An array of up to three Git repositories to associate with the notebook instance.
|
CreateNotebookInstanceRequest.Builder |
defaultCodeRepository(String defaultCodeRepository)
A Git repository to associate with the notebook instance as its default code repository.
|
CreateNotebookInstanceRequest.Builder |
directInternetAccess(DirectInternetAccess directInternetAccess)
Sets whether Amazon SageMaker provides internet access to the notebook instance.
|
CreateNotebookInstanceRequest.Builder |
directInternetAccess(String directInternetAccess)
Sets whether Amazon SageMaker provides internet access to the notebook instance.
|
CreateNotebookInstanceRequest.Builder |
instanceType(InstanceType instanceType)
The type of ML compute instance to launch for the notebook instance.
|
CreateNotebookInstanceRequest.Builder |
instanceType(String instanceType)
The type of ML compute instance to launch for the notebook instance.
|
CreateNotebookInstanceRequest.Builder |
kmsKeyId(String kmsKeyId)
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that Amazon SageMaker uses
to encrypt data on the storage volume attached to your notebook instance.
|
CreateNotebookInstanceRequest.Builder |
lifecycleConfigName(String lifecycleConfigName)
The name of a lifecycle configuration to associate with the notebook instance.
|
CreateNotebookInstanceRequest.Builder |
notebookInstanceName(String notebookInstanceName)
The name of the new notebook instance.
|
CreateNotebookInstanceRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateNotebookInstanceRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateNotebookInstanceRequest.Builder |
platformIdentifier(String platformIdentifier)
The platform identifier of the notebook instance runtime environment.
|
CreateNotebookInstanceRequest.Builder |
roleArn(String roleArn)
When you send any requests to Amazon Web Services resources from the notebook instance, Amazon SageMaker
assumes this role to perform tasks on your behalf.
|
CreateNotebookInstanceRequest.Builder |
rootAccess(RootAccess rootAccess)
Whether root access is enabled or disabled for users of the notebook instance.
|
CreateNotebookInstanceRequest.Builder |
rootAccess(String rootAccess)
Whether root access is enabled or disabled for users of the notebook instance.
|
CreateNotebookInstanceRequest.Builder |
securityGroupIds(Collection<String> securityGroupIds)
The VPC security group IDs, in the form sg-xxxxxxxx.
|
CreateNotebookInstanceRequest.Builder |
securityGroupIds(String... securityGroupIds)
The VPC security group IDs, in the form sg-xxxxxxxx.
|
CreateNotebookInstanceRequest.Builder |
subnetId(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.Builder |
tags(Collection<Tag> tags)
An array of key-value pairs.
|
CreateNotebookInstanceRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
An array of key-value pairs.
|
CreateNotebookInstanceRequest.Builder |
tags(Tag... tags)
An array of key-value pairs.
|
CreateNotebookInstanceRequest.Builder |
volumeSizeInGB(Integer volumeSizeInGB)
The size, in GB, of the ML storage volume to attach to the notebook instance.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateNotebookInstanceRequest.Builder notebookInstanceName(String notebookInstanceName)
The name of the new notebook instance.
notebookInstanceName - The name of the new notebook instance.CreateNotebookInstanceRequest.Builder instanceType(String instanceType)
The type of ML compute instance to launch for the notebook instance.
instanceType - The type of ML compute instance to launch for the notebook instance.InstanceType,
InstanceTypeCreateNotebookInstanceRequest.Builder instanceType(InstanceType instanceType)
The type of ML compute instance to launch for the notebook instance.
instanceType - The type of ML compute instance to launch for the notebook instance.InstanceType,
InstanceTypeCreateNotebookInstanceRequest.Builder subnetId(String subnetId)
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
subnetId - The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute
instance.CreateNotebookInstanceRequest.Builder securityGroupIds(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.
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.CreateNotebookInstanceRequest.Builder securityGroupIds(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.
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.CreateNotebookInstanceRequest.Builder roleArn(String roleArn)
When you send any requests to Amazon Web Services 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.
roleArn - When you send any requests to Amazon Web Services 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.
CreateNotebookInstanceRequest.Builder kmsKeyId(String kmsKeyId)
The Amazon Resource Name (ARN) of a Amazon Web Services 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 Amazon Web Services Key Management Service Developer Guide.
kmsKeyId - The Amazon Resource Name (ARN) of a Amazon Web Services 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 Amazon Web Services Key Management Service Developer Guide.CreateNotebookInstanceRequest.Builder tags(Collection<Tag> 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.
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.CreateNotebookInstanceRequest.Builder tags(Tag... 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.
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.CreateNotebookInstanceRequest.Builder tags(Consumer<Tag.Builder>... 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.
This is a convenience that creates an instance of theList.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateNotebookInstanceRequest.Builder lifecycleConfigName(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.
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.CreateNotebookInstanceRequest.Builder directInternetAccess(String directInternetAccess)
Sets whether Amazon 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 Amazon 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 the SubnetId parameter.
directInternetAccess - Sets whether Amazon 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 Amazon 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 the SubnetId parameter.
DirectInternetAccess,
DirectInternetAccessCreateNotebookInstanceRequest.Builder directInternetAccess(DirectInternetAccess directInternetAccess)
Sets whether Amazon 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 Amazon 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 the SubnetId parameter.
directInternetAccess - Sets whether Amazon 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 Amazon 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 the SubnetId parameter.
DirectInternetAccess,
DirectInternetAccessCreateNotebookInstanceRequest.Builder volumeSizeInGB(Integer volumeSizeInGB)
The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
volumeSizeInGB - The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5
GB.CreateNotebookInstanceRequest.Builder acceleratorTypesWithStrings(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.
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.CreateNotebookInstanceRequest.Builder acceleratorTypesWithStrings(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.
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.CreateNotebookInstanceRequest.Builder acceleratorTypes(Collection<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.
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.CreateNotebookInstanceRequest.Builder acceleratorTypes(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.
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.CreateNotebookInstanceRequest.Builder defaultCodeRepository(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 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 Amazon SageMaker Notebook Instances.
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 Amazon SageMaker Notebook Instances.CreateNotebookInstanceRequest.Builder additionalCodeRepositories(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 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 Amazon SageMaker Notebook Instances.
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 Amazon SageMaker Notebook Instances.CreateNotebookInstanceRequest.Builder additionalCodeRepositories(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 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 Amazon SageMaker Notebook Instances.
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 Amazon SageMaker Notebook Instances.CreateNotebookInstanceRequest.Builder rootAccess(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.
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.
RootAccess,
RootAccessCreateNotebookInstanceRequest.Builder rootAccess(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.
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.
RootAccess,
RootAccessCreateNotebookInstanceRequest.Builder platformIdentifier(String platformIdentifier)
The platform identifier of the notebook instance runtime environment.
platformIdentifier - The platform identifier of the notebook instance runtime environment.CreateNotebookInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateNotebookInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.