Package software.amazon.awscdk.services.sagemaker

Class CfnNotebookInstance.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnNotebookInstance.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnNotebookInstance>

Enclosing class:

CfnNotebookInstance

@Stability(Stable)
public static final class CfnNotebookInstance.Builder
extends Object
implements software.amazon.jsii.Builder<CfnNotebookInstance>

A fluent builder for CfnNotebookInstance.

Method Summary

Modifier and Type	Method	Description
CfnNotebookInstance.Builder	acceleratorTypes(List<String> acceleratorTypes)	A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
CfnNotebookInstance.Builder	additionalCodeRepositories(List<String> additionalCodeRepositories)	An array of up to three Git repositories associated with the notebook instance.
CfnNotebookInstance	build()
static CfnNotebookInstance.Builder	create(software.constructs.Construct scope, String id)
CfnNotebookInstance.Builder	defaultCodeRepository(String defaultCodeRepository)	The Git repository associated with the notebook instance as its default code repository.
CfnNotebookInstance.Builder	directInternetAccess(String directInternetAccess)	Sets whether SageMaker provides internet access to the notebook instance.
CfnNotebookInstance.Builder	instanceMetadataServiceConfiguration(IResolvable instanceMetadataServiceConfiguration)	Information on the IMDS configuration of the notebook instance.
CfnNotebookInstance.Builder	instanceMetadataServiceConfiguration(CfnNotebookInstance.InstanceMetadataServiceConfigurationProperty instanceMetadataServiceConfiguration)	Information on the IMDS configuration of the notebook instance.
CfnNotebookInstance.Builder	instanceType(String instanceType)	The type of ML compute instance to launch for the notebook instance.
CfnNotebookInstance.Builder	kmsKeyId(String kmsKeyId)	The Amazon Resource Name (ARN) of a AWS Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance.
CfnNotebookInstance.Builder	lifecycleConfigName(String lifecycleConfigName)	The name of a lifecycle configuration to associate with the notebook instance.
CfnNotebookInstance.Builder	notebookInstanceName(String notebookInstanceName)	The name of the new notebook instance.
CfnNotebookInstance.Builder	platformIdentifier(String platformIdentifier)	The platform identifier of the notebook instance runtime environment.
CfnNotebookInstance.Builder	roleArn(String roleArn)	When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
CfnNotebookInstance.Builder	rootAccess(String rootAccess)	Whether root access is enabled or disabled for users of the notebook instance.
CfnNotebookInstance.Builder	securityGroupIds(List<String> securityGroupIds)	The VPC security group IDs, in the form sg-xxxxxxxx.
CfnNotebookInstance.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.
CfnNotebookInstance.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs to apply to this resource.
CfnNotebookInstance.Builder	volumeSizeInGb(Number volumeSizeInGb)	The size, in GB, of the ML storage volume to attach to the notebook instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnNotebookInstance.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnNotebookInstance.Builder.

instanceType

@Stability(Stable)
public CfnNotebookInstance.Builder instanceType(String instanceType)

The type of ML compute instance to launch for the notebook instance.

Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.

Parameters:

instanceType - The type of ML compute instance to launch for the notebook instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancetype

roleArn

@Stability(Stable)
public CfnNotebookInstance.Builder roleArn(String roleArn)

When you send any requests to AWS 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 AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rolearn

acceleratorTypes

@Stability(Stable)
public CfnNotebookInstance.Builder acceleratorTypes(List<String> acceleratorTypes)

A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.

Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker .

Valid Values: ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge .

Parameters:

acceleratorTypes - A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-acceleratortypes

additionalCodeRepositories

@Stability(Stable)
public CfnNotebookInstance.Builder additionalCodeRepositories(List<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 AWS 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 associated with the notebook instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-additionalcoderepositories

defaultCodeRepository

@Stability(Stable)
public CfnNotebookInstance.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 AWS 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 - The Git repository associated with the notebook instance as its default code repository. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-defaultcoderepository

directInternetAccess

@Stability(Stable)
public CfnNotebookInstance.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-directinternetaccess

instanceMetadataServiceConfiguration

@Stability(Stable)
public CfnNotebookInstance.Builder instanceMetadataServiceConfiguration(IResolvable instanceMetadataServiceConfiguration)

Information on the IMDS configuration of the notebook instance.

Parameters:

instanceMetadataServiceConfiguration - Information on the IMDS configuration of the notebook instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancemetadataserviceconfiguration

instanceMetadataServiceConfiguration

@Stability(Stable)
public CfnNotebookInstance.Builder instanceMetadataServiceConfiguration(CfnNotebookInstance.InstanceMetadataServiceConfigurationProperty instanceMetadataServiceConfiguration)

Information on the IMDS configuration of the notebook instance.

Parameters:

instanceMetadataServiceConfiguration - Information on the IMDS configuration of the notebook instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancemetadataserviceconfiguration

kmsKeyId

@Stability(Stable)
public CfnNotebookInstance.Builder kmsKeyId(String kmsKeyId)

The Amazon Resource Name (ARN) of a AWS 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 AWS Key Management Service Developer Guide .

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of a AWS Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-kmskeyid

lifecycleConfigName

@Stability(Stable)
public CfnNotebookInstance.Builder lifecycleConfigName(String lifecycleConfigName)

The name of a lifecycle configuration to associate with the notebook instance.

For information about lifecycle configurations, see Customize a Notebook Instance in the Amazon SageMaker Developer Guide .

Parameters:

lifecycleConfigName - The name of a lifecycle configuration to associate with the notebook instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-lifecycleconfigname

notebookInstanceName

@Stability(Stable)
public CfnNotebookInstance.Builder notebookInstanceName(String notebookInstanceName)

The name of the new notebook instance.

Parameters:

notebookInstanceName - The name of the new notebook instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-notebookinstancename

platformIdentifier

@Stability(Stable)
public CfnNotebookInstance.Builder platformIdentifier(String platformIdentifier)

The platform identifier of the notebook instance runtime environment.

Parameters:

platformIdentifier - The platform identifier of the notebook instance runtime environment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-platformidentifier

rootAccess

@Stability(Stable)
public CfnNotebookInstance.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 . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rootaccess

securityGroupIds

@Stability(Stable)
public CfnNotebookInstance.Builder securityGroupIds(List<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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-securitygroupids

subnetId

@Stability(Stable)
public CfnNotebookInstance.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-subnetid

tags

@Stability(Stable)
public CfnNotebookInstance.Builder tags(List<? extends CfnTag> tags)

A list of key-value pairs to apply to this resource.

For more information, see Resource Tag and Using Cost Allocation Tags .

You can add tags later by using the CreateTags API.

Parameters:

tags - A list of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-tags

volumeSizeInGb

@Stability(Stable)
public CfnNotebookInstance.Builder volumeSizeInGb(Number volumeSizeInGb)

The size, in GB, of the ML storage volume to attach to the notebook instance.

The default value is 5 GB.

Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.

Parameters:

volumeSizeInGb - The size, in GB, of the ML storage volume to attach to the notebook instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-volumesizeingb

build

@Stability(Stable)
public CfnNotebookInstance build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnNotebookInstance>

Returns:

a newly built instance of CfnNotebookInstance.