Interface AwsSageMakerNotebookInstanceDetails.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<AwsSageMakerNotebookInstanceDetails.Builder,AwsSageMakerNotebookInstanceDetails>,SdkBuilder<AwsSageMakerNotebookInstanceDetails.Builder,AwsSageMakerNotebookInstanceDetails>,SdkPojo
- Enclosing class:
- AwsSageMakerNotebookInstanceDetails
public static interface AwsSageMakerNotebookInstanceDetails.Builder extends SdkPojo, CopyableBuilder<AwsSageMakerNotebookInstanceDetails.Builder,AwsSageMakerNotebookInstanceDetails>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description AwsSageMakerNotebookInstanceDetails.BuilderacceleratorTypes(String... acceleratorTypes)A list of Amazon Elastic Inference instance types to associate with the notebook instance.AwsSageMakerNotebookInstanceDetails.BuilderacceleratorTypes(Collection<String> acceleratorTypes)A list of Amazon Elastic Inference instance types to associate with the notebook instance.AwsSageMakerNotebookInstanceDetails.BuilderadditionalCodeRepositories(String... additionalCodeRepositories)An array of up to three Git repositories associated with the notebook instance.AwsSageMakerNotebookInstanceDetails.BuilderadditionalCodeRepositories(Collection<String> additionalCodeRepositories)An array of up to three Git repositories associated with the notebook instance.AwsSageMakerNotebookInstanceDetails.BuilderdefaultCodeRepository(String defaultCodeRepository)The Git repository associated with the notebook instance as its default code repository.AwsSageMakerNotebookInstanceDetails.BuilderdirectInternetAccess(String directInternetAccess)Sets whether SageMaker AI provides internet access to the notebook instance.AwsSageMakerNotebookInstanceDetails.BuilderfailureReason(String failureReason)If status of the instance isFailed, the reason it failed.default AwsSageMakerNotebookInstanceDetails.BuilderinstanceMetadataServiceConfiguration(Consumer<AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails.Builder> instanceMetadataServiceConfiguration)Information on the IMDS configuration of the notebook instance.AwsSageMakerNotebookInstanceDetails.BuilderinstanceMetadataServiceConfiguration(AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails instanceMetadataServiceConfiguration)Information on the IMDS configuration of the notebook instance.AwsSageMakerNotebookInstanceDetails.BuilderinstanceType(String instanceType)The type of machine learning (ML) compute instance to launch for the notebook instance.AwsSageMakerNotebookInstanceDetails.BuilderkmsKeyId(String kmsKeyId)The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that SageMaker AI uses to encrypt data on the storage volume attached to your notebook instance.AwsSageMakerNotebookInstanceDetails.BuildernetworkInterfaceId(String networkInterfaceId)The network interface ID that SageMaker AI created when the instance was created.AwsSageMakerNotebookInstanceDetails.BuildernotebookInstanceArn(String notebookInstanceArn)The Amazon Resource Name (ARN) of the notebook instance.AwsSageMakerNotebookInstanceDetails.BuildernotebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName)The name of a notebook instance lifecycle configuration.AwsSageMakerNotebookInstanceDetails.BuildernotebookInstanceName(String notebookInstanceName)The name of the new notebook instance.AwsSageMakerNotebookInstanceDetails.BuildernotebookInstanceStatus(String notebookInstanceStatus)The status of the notebook instance.AwsSageMakerNotebookInstanceDetails.BuilderplatformIdentifier(String platformIdentifier)The platform identifier of the notebook instance runtime environment.AwsSageMakerNotebookInstanceDetails.BuilderroleArn(String roleArn)The Amazon Resource Name (ARN) of the IAM role associated with the instance.AwsSageMakerNotebookInstanceDetails.BuilderrootAccess(String rootAccess)Whether root access is enabled or disabled for users of the notebook instance.AwsSageMakerNotebookInstanceDetails.BuildersecurityGroups(String... securityGroups)The VPC security group IDs.AwsSageMakerNotebookInstanceDetails.BuildersecurityGroups(Collection<String> securityGroups)The VPC security group IDs.AwsSageMakerNotebookInstanceDetails.BuildersubnetId(String subnetId)The ID of the VPC subnet to which you have a connectivity from your ML compute instance.AwsSageMakerNotebookInstanceDetails.Builderurl(String url)The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.AwsSageMakerNotebookInstanceDetails.BuildervolumeSizeInGB(Integer volumeSizeInGB)The size, in GB, of the ML storage volume to attach to the notebook instance.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
acceleratorTypes
AwsSageMakerNotebookInstanceDetails.Builder acceleratorTypes(Collection<String> acceleratorTypes)
A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
- Parameters:
acceleratorTypes- A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
acceleratorTypes
AwsSageMakerNotebookInstanceDetails.Builder acceleratorTypes(String... acceleratorTypes)
A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
- Parameters:
acceleratorTypes- A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalCodeRepositories
AwsSageMakerNotebookInstanceDetails.Builder additionalCodeRepositories(Collection<String> additionalCodeRepositories)
An array of up to three Git repositories associated 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 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 AI notebook instances in the Amazon SageMaker AI Developer Guide.
- Parameters:
additionalCodeRepositories- An array of up to three Git repositories associated 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 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 AI notebook instances in the Amazon SageMaker AI Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalCodeRepositories
AwsSageMakerNotebookInstanceDetails.Builder additionalCodeRepositories(String... additionalCodeRepositories)
An array of up to three Git repositories associated 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 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 AI notebook instances in the Amazon SageMaker AI Developer Guide.
- Parameters:
additionalCodeRepositories- An array of up to three Git repositories associated 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 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 AI notebook instances in the Amazon SageMaker AI Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultCodeRepository
AwsSageMakerNotebookInstanceDetails.Builder defaultCodeRepository(String defaultCodeRepository)
The Git repository associated 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 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 AI notebook instances in the Amazon SageMaker AI Developer Guide.
- Parameters:
defaultCodeRepository- The Git repository associated 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 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 AI notebook instances in the Amazon SageMaker AI Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
directInternetAccess
AwsSageMakerNotebookInstanceDetails.Builder directInternetAccess(String directInternetAccess)
Sets whether SageMaker AI 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 AI training and endpoint services unless you configure a Network Address Translation (NAT) Gateway in your VPC.- Parameters:
directInternetAccess- Sets whether SageMaker AI provides internet access to the notebook instance. If you set this toDisabled, this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker AI training and endpoint services unless you configure a Network Address Translation (NAT) Gateway in your VPC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failureReason
AwsSageMakerNotebookInstanceDetails.Builder failureReason(String failureReason)
If status of the instance is
Failed, the reason it failed.- Parameters:
failureReason- If status of the instance isFailed, the reason it failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceMetadataServiceConfiguration
AwsSageMakerNotebookInstanceDetails.Builder instanceMetadataServiceConfiguration(AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails 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 AwsSageMakerNotebookInstanceDetails.Builder instanceMetadataServiceConfiguration(Consumer<AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails.Builder> instanceMetadataServiceConfiguration)
Information on the IMDS configuration of the notebook instance.
This is a convenience method that creates an instance of theAwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails.Builderavoiding the need to create one manually viaAwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toinstanceMetadataServiceConfiguration(AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails).- Parameters:
instanceMetadataServiceConfiguration- a consumer that will call methods onAwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
instanceMetadataServiceConfiguration(AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails)
-
instanceType
AwsSageMakerNotebookInstanceDetails.Builder instanceType(String instanceType)
The type of machine learning (ML) compute instance to launch for the notebook instance.
- Parameters:
instanceType- The type of machine learning (ML) compute instance to launch for the notebook instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
AwsSageMakerNotebookInstanceDetails.Builder kmsKeyId(String kmsKeyId)
The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that SageMaker AI 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 Key Management Service Developer Guide.
- Parameters:
kmsKeyId- The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that SageMaker AI 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 Key Management Service Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkInterfaceId
AwsSageMakerNotebookInstanceDetails.Builder networkInterfaceId(String networkInterfaceId)
The network interface ID that SageMaker AI created when the instance was created.
- Parameters:
networkInterfaceId- The network interface ID that SageMaker AI created when the instance was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notebookInstanceArn
AwsSageMakerNotebookInstanceDetails.Builder notebookInstanceArn(String notebookInstanceArn)
The Amazon Resource Name (ARN) of the notebook instance.
- Parameters:
notebookInstanceArn- The Amazon Resource Name (ARN) of the notebook instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notebookInstanceLifecycleConfigName
AwsSageMakerNotebookInstanceDetails.Builder notebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName)
The name of a notebook instance lifecycle configuration.
- Parameters:
notebookInstanceLifecycleConfigName- The name of a notebook instance lifecycle configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notebookInstanceName
AwsSageMakerNotebookInstanceDetails.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.
-
notebookInstanceStatus
AwsSageMakerNotebookInstanceDetails.Builder notebookInstanceStatus(String notebookInstanceStatus)
The status of the notebook instance.
- Parameters:
notebookInstanceStatus- The status of the notebook instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformIdentifier
AwsSageMakerNotebookInstanceDetails.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.
-
roleArn
AwsSageMakerNotebookInstanceDetails.Builder roleArn(String roleArn)
The Amazon Resource Name (ARN) of the IAM role associated with the instance.
- Parameters:
roleArn- The Amazon Resource Name (ARN) of the IAM role associated with the instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rootAccess
AwsSageMakerNotebookInstanceDetails.Builder rootAccess(String rootAccess)
Whether root access is enabled or disabled for users of the notebook instance.
- Parameters:
rootAccess- Whether root access is enabled or disabled for users of the notebook instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroups
AwsSageMakerNotebookInstanceDetails.Builder securityGroups(Collection<String> securityGroups)
The VPC security group IDs.
- Parameters:
securityGroups- The VPC security group IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroups
AwsSageMakerNotebookInstanceDetails.Builder securityGroups(String... securityGroups)
The VPC security group IDs.
- Parameters:
securityGroups- The VPC security group IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetId
AwsSageMakerNotebookInstanceDetails.Builder subnetId(String subnetId)
The ID of the VPC subnet to which you have a connectivity from your ML compute instance.
- Parameters:
subnetId- The ID of the VPC subnet to which you have a connectivity from your ML compute instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
url
AwsSageMakerNotebookInstanceDetails.Builder url(String url)
The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
- Parameters:
url- The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumeSizeInGB
AwsSageMakerNotebookInstanceDetails.Builder volumeSizeInGB(Integer volumeSizeInGB)
The size, in GB, of the ML storage volume to attach to the notebook instance.
- Parameters:
volumeSizeInGB- The size, in GB, of the ML storage volume to attach to the notebook instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-