Package software.amazon.awssdk.services.sagemaker.model

Interface CreateNotebookInstanceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateNotebookInstanceRequest.Builder,CreateNotebookInstanceRequest>, SageMakerRequest.Builder, SdkBuilder<CreateNotebookInstanceRequest.Builder,CreateNotebookInstanceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateNotebookInstanceRequest
public static interface CreateNotebookInstanceRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateNotebookInstanceRequest.Builder,CreateNotebookInstanceRequest>

  • Method Details

    • notebookInstanceName

      CreateNotebookInstanceRequest.Builder notebookInstanceName(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.

    • instanceType

      CreateNotebookInstanceRequest.Builder instanceType(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

      CreateNotebookInstanceRequest.Builder instanceType(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:

    • subnetId

      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.

      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.

    • securityGroupIds

      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.

      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.

    • securityGroupIds

      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.

      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.

    • roleArn

      CreateNotebookInstanceRequest.Builder roleArn(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. 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CreateNotebookInstanceRequest.Builder kmsKeyId(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. 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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 method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lifecycleConfigName

      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.

      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.

    • directInternetAccess

      CreateNotebookInstanceRequest.Builder directInternetAccess(String 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 the SubnetId parameter.

      Parameters:
      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 the SubnetId parameter.

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

    • directInternetAccess

      CreateNotebookInstanceRequest.Builder directInternetAccess(DirectInternetAccess 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 the SubnetId parameter.

      Parameters:
      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 the SubnetId parameter.

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

    • volumeSizeInGB

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

      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.

    • acceleratorTypesWithStrings

      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.

      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.

    • acceleratorTypesWithStrings

      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.

      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.

    • acceleratorTypes

      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.

      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.

    • acceleratorTypes

      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.

      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.

    • defaultCodeRepository

      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 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 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:
      Returns a reference to this object so that method calls can be chained together.

    • additionalCodeRepositories

      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 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 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalCodeRepositories

      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 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 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rootAccess

      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.

      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

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

      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:

    • platformIdentifier

      CreateNotebookInstanceRequest.Builder platformIdentifier(String platformIdentifier)

      The platform identifier of the notebook instance runtime environment.

      Parameters:
      platformIdentifier - The platform identifier of the notebook instance runtime environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceMetadataServiceConfiguration

      CreateNotebookInstanceRequest.Builder instanceMetadataServiceConfiguration(InstanceMetadataServiceConfiguration instanceMetadataServiceConfiguration)

      Information on the IMDS configuration of the notebook instance

      Parameters:
      instanceMetadataServiceConfiguration - Information on the IMDS configuration of the notebook instance
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceMetadataServiceConfiguration

      default CreateNotebookInstanceRequest.Builder instanceMetadataServiceConfiguration(Consumer<InstanceMetadataServiceConfiguration.Builder> instanceMetadataServiceConfiguration)

      Information on the IMDS configuration of the notebook instance

      This is a convenience method that creates an instance of the InstanceMetadataServiceConfiguration.Builder avoiding the need to create one manually via InstanceMetadataServiceConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceMetadataServiceConfiguration(InstanceMetadataServiceConfiguration).

      Parameters:
      instanceMetadataServiceConfiguration - a consumer that will call methods on InstanceMetadataServiceConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateNotebookInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateNotebookInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.