Class NotebookInstance

Provides a Sagemaker Notebook Instance resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var ni = new Aws.Sagemaker.NotebookInstance("ni", new Aws.Sagemaker.NotebookInstanceArgs
    {
        InstanceType = "ml.t2.medium",
        RoleArn = aws_iam_role.Role.Arn,
        Tags = 
        {
            { "Name", "foo" },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

NotebookInstance

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Sagemaker

Assembly: Pulumi.Aws.dll

Syntax

public class NotebookInstance : CustomResource

Constructors

NotebookInstance(String, NotebookInstanceArgs, CustomResourceOptions)

Create a NotebookInstance resource with the given unique name, arguments, and options.

Declaration

public NotebookInstance(string name, NotebookInstanceArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
NotebookInstanceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

The Amazon Resource Name (ARN) assigned by AWS to this notebook instance.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

DirectInternetAccess

Set to Disabled to disable internet access to notebook. Requires security_groups and subnet_id to be set. Supported values: Enabled (Default) or Disabled. If set to Disabled, the notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC.

Declaration

public Output<string> DirectInternetAccess { get; }

Property Value

Type	Description
Output<System.String>

InstanceType

The name of ML compute instance type.

Declaration

public Output<string> InstanceType { get; }

Property Value

Type	Description
Output<System.String>

KmsKeyId

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

Declaration

public Output<string> KmsKeyId { get; }

Property Value

Type	Description
Output<System.String>

LifecycleConfigName

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

Declaration

public Output<string> LifecycleConfigName { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the notebook instance (must be unique).

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

RoleArn

The ARN of the IAM role to be used by the notebook instance which allows SageMaker to call other services on your behalf.

Declaration

public Output<string> RoleArn { get; }

Property Value

Type	Description
Output<System.String>

SecurityGroups

The associated security groups.

Declaration

public Output<ImmutableArray<string>> SecurityGroups { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

SubnetId

The VPC subnet ID.

Declaration

public Output<string> SubnetId { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, NotebookInstanceState, CustomResourceOptions)

Get an existing NotebookInstance resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static NotebookInstance Get(string name, Input<string> id, NotebookInstanceState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
NotebookInstanceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
NotebookInstance