@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-13T01:13:30.359Z") public class CfnNotebookInstance extends CfnResource implements IInspectable
The AWS::SageMaker::NotebookInstance
resource creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. For more information, see Use Notebook Instances .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.sagemaker.*; CfnNotebookInstance cfnNotebookInstance = CfnNotebookInstance.Builder.create(this, "MyCfnNotebookInstance") .instanceType("instanceType") .roleArn("roleArn") // the properties below are optional .acceleratorTypes(List.of("acceleratorTypes")) .additionalCodeRepositories(List.of("additionalCodeRepositories")) .defaultCodeRepository("defaultCodeRepository") .directInternetAccess("directInternetAccess") .kmsKeyId("kmsKeyId") .lifecycleConfigName("lifecycleConfigName") .notebookInstanceName("notebookInstanceName") .platformIdentifier("platformIdentifier") .rootAccess("rootAccess") .securityGroupIds(List.of("securityGroupIds")) .subnetId("subnetId") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .volumeSizeInGb(123) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnNotebookInstance.Builder
A fluent builder for
CfnNotebookInstance . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnNotebookInstance(Construct scope,
java.lang.String id,
CfnNotebookInstanceProps props)
Create a new `AWS::SageMaker::NotebookInstance`.
|
protected |
CfnNotebookInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnNotebookInstance(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
getAcceleratorTypes()
A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
|
java.util.List<java.lang.String> |
getAdditionalCodeRepositories()
An array of up to three Git repositories associated with the notebook instance.
|
java.lang.String |
getAttrNotebookInstanceName()
The name of the notebook instance, such as `MyNotebookInstance` .
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDefaultCodeRepository()
The Git repository associated with the notebook instance as its default code repository.
|
java.lang.String |
getDirectInternetAccess()
Sets whether SageMaker provides internet access to the notebook instance.
|
java.lang.String |
getInstanceType()
The type of ML compute instance to launch for the notebook instance.
|
java.lang.String |
getKmsKeyId()
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.
|
java.lang.String |
getLifecycleConfigName()
The name of a lifecycle configuration to associate with the notebook instance.
|
java.lang.String |
getNotebookInstanceName()
The name of the new notebook instance.
|
java.lang.String |
getPlatformIdentifier()
The platform identifier of the notebook instance runtime environment.
|
java.lang.String |
getRoleArn()
When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
|
java.lang.String |
getRootAccess()
Whether root access is enabled or disabled for users of the notebook instance.
|
java.util.List<java.lang.String> |
getSecurityGroupIds()
The VPC security group IDs, in the form sg-xxxxxxxx.
|
java.lang.String |
getSubnetId()
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
|
TagManager |
getTags()
A list of key-value pairs to apply to this resource.
|
java.lang.Number |
getVolumeSizeInGb()
The size, in GB, of the ML storage volume to attach to the notebook instance.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAcceleratorTypes(java.util.List<java.lang.String> value)
A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
|
void |
setAdditionalCodeRepositories(java.util.List<java.lang.String> value)
An array of up to three Git repositories associated with the notebook instance.
|
void |
setDefaultCodeRepository(java.lang.String value)
The Git repository associated with the notebook instance as its default code repository.
|
void |
setDirectInternetAccess(java.lang.String value)
Sets whether SageMaker provides internet access to the notebook instance.
|
void |
setInstanceType(java.lang.String value)
The type of ML compute instance to launch for the notebook instance.
|
void |
setKmsKeyId(java.lang.String value)
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.
|
void |
setLifecycleConfigName(java.lang.String value)
The name of a lifecycle configuration to associate with the notebook instance.
|
void |
setNotebookInstanceName(java.lang.String value)
The name of the new notebook instance.
|
void |
setPlatformIdentifier(java.lang.String value)
The platform identifier of the notebook instance runtime environment.
|
void |
setRoleArn(java.lang.String value)
When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
|
void |
setRootAccess(java.lang.String value)
Whether root access is enabled or disabled for users of the notebook instance.
|
void |
setSecurityGroupIds(java.util.List<java.lang.String> value)
The VPC security group IDs, in the form sg-xxxxxxxx.
|
void |
setSubnetId(java.lang.String value)
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
|
void |
setVolumeSizeInGb(java.lang.Number value)
The size, in GB, of the ML storage volume to attach to the notebook instance.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnNotebookInstance(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnNotebookInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnNotebookInstance(Construct scope, java.lang.String id, CfnNotebookInstanceProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrNotebookInstanceName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Resource Tag and Using Cost Allocation Tags .
You can add tags later by using the CreateTags
API.
public java.lang.String getInstanceType()
Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
public void setInstanceType(java.lang.String value)
Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
public java.lang.String getRoleArn()
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.
public void setRoleArn(java.lang.String value)
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.
public java.util.List<java.lang.String> getAcceleratorTypes()
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
.
public void setAcceleratorTypes(java.util.List<java.lang.String> value)
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
.
public java.util.List<java.lang.String> getAdditionalCodeRepositories()
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 .
public void setAdditionalCodeRepositories(java.util.List<java.lang.String> value)
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 .
public java.lang.String getDefaultCodeRepository()
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 .
public void setDefaultCodeRepository(java.lang.String value)
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 .
public java.lang.String getDirectInternetAccess()
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.
public void setDirectInternetAccess(java.lang.String value)
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.
public java.lang.String getKmsKeyId()
The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide .
public void setKmsKeyId(java.lang.String value)
The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide .
public java.lang.String getLifecycleConfigName()
For information about lifecycle configurations, see Customize a Notebook Instance in the Amazon SageMaker Developer Guide .
public void setLifecycleConfigName(java.lang.String value)
For information about lifecycle configurations, see Customize a Notebook Instance in the Amazon SageMaker Developer Guide .
public java.lang.String getNotebookInstanceName()
public void setNotebookInstanceName(java.lang.String value)
public java.lang.String getPlatformIdentifier()
public void setPlatformIdentifier(java.lang.String value)
public java.lang.String getRootAccess()
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.
public void setRootAccess(java.lang.String value)
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.
public java.util.List<java.lang.String> getSecurityGroupIds()
The security groups must be for the same VPC as specified in the subnet.
public void setSecurityGroupIds(java.util.List<java.lang.String> value)
The security groups must be for the same VPC as specified in the subnet.
public java.lang.String getSubnetId()
public void setSubnetId(java.lang.String value)
public java.lang.Number getVolumeSizeInGb()
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.
public void setVolumeSizeInGb(java.lang.Number value)
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.