software.amazon.awssdk.services.sagemaker.model

Interface CreateNotebookInstanceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<CreateNotebookInstanceRequest.Builder,CreateNotebookInstanceRequest>, SageMakerRequest.Builder, SdkBuilder<CreateNotebookInstanceRequest.Builder,CreateNotebookInstanceRequest>, SdkRequest.Builder

Enclosing class:

CreateNotebookInstanceRequest

public static interface CreateNotebookInstanceRequest.Builder
extends SageMakerRequest.Builder, CopyableBuilder<CreateNotebookInstanceRequest.Builder,CreateNotebookInstanceRequest>

Method Summary

Modifier and Type	Method and Description
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) 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.Builder	notebookInstanceName(String notebookInstanceName) The name of the new notebook instance.
CreateNotebookInstanceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateNotebookInstanceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateNotebookInstanceRequest.Builder	roleArn(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.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) A list of tags to associate with the notebook instance.
CreateNotebookInstanceRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of tags to associate with the notebook instance.
CreateNotebookInstanceRequest.Builder	tags(Tag... tags) A list of tags to associate with the notebook instance.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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, InstanceType

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:

InstanceType, InstanceType

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

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.

Returns:

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

kmsKeyId

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

tags

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

tags

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

tags

CreateNotebookInstanceRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.

This is a convenience that creates an instance of the List.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).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

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.