sagemakerNotebookInstance.typescript.md

sagemakerNotebookInstance Submodule

Constructs

SagemakerNotebookInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance aws_sagemaker_notebook_instance}.

Initializers

import { sagemakerNotebookInstance } from '@cdktf/provider-aws'

new sagemakerNotebookInstance.SagemakerNotebookInstance(scope: Construct, id: string, config: SagemakerNotebookInstanceConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	SagemakerNotebookInstanceConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: SagemakerNotebookInstanceConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putInstanceMetadataServiceConfiguration	No description.
resetAcceleratorTypes	No description.
resetAdditionalCodeRepositories	No description.
resetDefaultCodeRepository	No description.
resetDirectInternetAccess	No description.
resetId	No description.
resetInstanceMetadataServiceConfiguration	No description.
resetKmsKeyId	No description.
resetLifecycleConfigName	No description.
resetPlatformIdentifier	No description.
resetRootAccess	No description.
resetSecurityGroups	No description.
resetSubnetId	No description.
resetTags	No description.
resetTagsAll	No description.
resetVolumeSize	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putInstanceMetadataServiceConfiguration

public putInstanceMetadataServiceConfiguration(value: SagemakerNotebookInstanceInstanceMetadataServiceConfiguration): void

value^Required

• Type: SagemakerNotebookInstanceInstanceMetadataServiceConfiguration

---

resetAcceleratorTypes

public resetAcceleratorTypes(): void

resetAdditionalCodeRepositories

public resetAdditionalCodeRepositories(): void

resetDefaultCodeRepository

public resetDefaultCodeRepository(): void

resetDirectInternetAccess

public resetDirectInternetAccess(): void

resetId

public resetId(): void

resetInstanceMetadataServiceConfiguration

public resetInstanceMetadataServiceConfiguration(): void

resetKmsKeyId

public resetKmsKeyId(): void

resetLifecycleConfigName

public resetLifecycleConfigName(): void

resetPlatformIdentifier

public resetPlatformIdentifier(): void

resetRootAccess

public resetRootAccess(): void

resetSecurityGroups

public resetSecurityGroups(): void

resetSubnetId

public resetSubnetId(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

resetVolumeSize

public resetVolumeSize(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a SagemakerNotebookInstance resource upon running "cdktf plan ".

---

isConstruct

import { sagemakerNotebookInstance } from '@cdktf/provider-aws'

sagemakerNotebookInstance.SagemakerNotebookInstance.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { sagemakerNotebookInstance } from '@cdktf/provider-aws'

sagemakerNotebookInstance.SagemakerNotebookInstance.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { sagemakerNotebookInstance } from '@cdktf/provider-aws'

sagemakerNotebookInstance.SagemakerNotebookInstance.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { sagemakerNotebookInstance } from '@cdktf/provider-aws'

sagemakerNotebookInstance.SagemakerNotebookInstance.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a SagemakerNotebookInstance resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the SagemakerNotebookInstance to import.

---

importFromId^Required

• Type: string

The id of the existing SagemakerNotebookInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the SagemakerNotebookInstance to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
arn	string	No description.
instanceMetadataServiceConfiguration	SagemakerNotebookInstanceInstanceMetadataServiceConfigurationOutputReference	No description.
networkInterfaceId	string	No description.
url	string	No description.
acceleratorTypesInput	string[]	No description.
additionalCodeRepositoriesInput	string[]	No description.
defaultCodeRepositoryInput	string	No description.
directInternetAccessInput	string	No description.
idInput	string	No description.
instanceMetadataServiceConfigurationInput	SagemakerNotebookInstanceInstanceMetadataServiceConfiguration	No description.
instanceTypeInput	string	No description.
kmsKeyIdInput	string	No description.
lifecycleConfigNameInput	string	No description.
nameInput	string	No description.
platformIdentifierInput	string	No description.
roleArnInput	string	No description.
rootAccessInput	string	No description.
securityGroupsInput	string[]	No description.
subnetIdInput	string	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
volumeSizeInput	number	No description.
acceleratorTypes	string[]	No description.
additionalCodeRepositories	string[]	No description.
defaultCodeRepository	string	No description.
directInternetAccess	string	No description.
id	string	No description.
instanceType	string	No description.
kmsKeyId	string	No description.
lifecycleConfigName	string	No description.
name	string	No description.
platformIdentifier	string	No description.
roleArn	string	No description.
rootAccess	string	No description.
securityGroups	string[]	No description.
subnetId	string	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.
volumeSize	number	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

arn^Required

public readonly arn: string;

• Type: string

---

instanceMetadataServiceConfiguration^Required

public readonly instanceMetadataServiceConfiguration: SagemakerNotebookInstanceInstanceMetadataServiceConfigurationOutputReference;

• Type: SagemakerNotebookInstanceInstanceMetadataServiceConfigurationOutputReference

---

networkInterfaceId^Required

public readonly networkInterfaceId: string;

• Type: string

---

url^Required

public readonly url: string;

• Type: string

---

acceleratorTypesInput^Optional

public readonly acceleratorTypesInput: string[];

• Type: string[]

---

additionalCodeRepositoriesInput^Optional

public readonly additionalCodeRepositoriesInput: string[];

• Type: string[]

---

defaultCodeRepositoryInput^Optional

public readonly defaultCodeRepositoryInput: string;

• Type: string

---

directInternetAccessInput^Optional

public readonly directInternetAccessInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

instanceMetadataServiceConfigurationInput^Optional

public readonly instanceMetadataServiceConfigurationInput: SagemakerNotebookInstanceInstanceMetadataServiceConfiguration;

• Type: SagemakerNotebookInstanceInstanceMetadataServiceConfiguration

---

instanceTypeInput^Optional

public readonly instanceTypeInput: string;

• Type: string

---

kmsKeyIdInput^Optional

public readonly kmsKeyIdInput: string;

• Type: string

---

lifecycleConfigNameInput^Optional

public readonly lifecycleConfigNameInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

platformIdentifierInput^Optional

public readonly platformIdentifierInput: string;

• Type: string

---

roleArnInput^Optional

public readonly roleArnInput: string;

• Type: string

---

rootAccessInput^Optional

public readonly rootAccessInput: string;

• Type: string

---

securityGroupsInput^Optional

public readonly securityGroupsInput: string[];

• Type: string[]

---

subnetIdInput^Optional

public readonly subnetIdInput: string;

• Type: string

---

tagsAllInput^Optional

public readonly tagsAllInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

volumeSizeInput^Optional

public readonly volumeSizeInput: number;

• Type: number

---

acceleratorTypes^Required

public readonly acceleratorTypes: string[];

• Type: string[]

---

additionalCodeRepositories^Required

public readonly additionalCodeRepositories: string[];

• Type: string[]

---

defaultCodeRepository^Required

public readonly defaultCodeRepository: string;

• Type: string

---

directInternetAccess^Required

public readonly directInternetAccess: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

instanceType^Required

public readonly instanceType: string;

• Type: string

---

kmsKeyId^Required

public readonly kmsKeyId: string;

• Type: string

---

lifecycleConfigName^Required

public readonly lifecycleConfigName: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

platformIdentifier^Required

public readonly platformIdentifier: string;

• Type: string

---

roleArn^Required

public readonly roleArn: string;

• Type: string

---

rootAccess^Required

public readonly rootAccess: string;

• Type: string

---

securityGroups^Required

public readonly securityGroups: string[];

• Type: string[]

---

subnetId^Required

public readonly subnetId: string;

• Type: string

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsAll^Required

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

volumeSize^Required

public readonly volumeSize: number;

• Type: number

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

SagemakerNotebookInstanceConfig

Initializer

import { sagemakerNotebookInstance } from '@cdktf/provider-aws'

const sagemakerNotebookInstanceConfig: sagemakerNotebookInstance.SagemakerNotebookInstanceConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
instanceType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#instance_type SagemakerNotebookInstance#instance_type}.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#name SagemakerNotebookInstance#name}.
roleArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#role_arn SagemakerNotebookInstance#role_arn}.
acceleratorTypes	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#accelerator_types SagemakerNotebookInstance#accelerator_types}.
additionalCodeRepositories	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#additional_code_repositories SagemakerNotebookInstance#additional_code_repositories}.
defaultCodeRepository	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#default_code_repository SagemakerNotebookInstance#default_code_repository}.
directInternetAccess	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#direct_internet_access SagemakerNotebookInstance#direct_internet_access}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#id SagemakerNotebookInstance#id}.
instanceMetadataServiceConfiguration	SagemakerNotebookInstanceInstanceMetadataServiceConfiguration	instance_metadata_service_configuration block.
kmsKeyId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#kms_key_id SagemakerNotebookInstance#kms_key_id}.
lifecycleConfigName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#lifecycle_config_name SagemakerNotebookInstance#lifecycle_config_name}.
platformIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#platform_identifier SagemakerNotebookInstance#platform_identifier}.
rootAccess	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#root_access SagemakerNotebookInstance#root_access}.
securityGroups	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#security_groups SagemakerNotebookInstance#security_groups}.
subnetId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#subnet_id SagemakerNotebookInstance#subnet_id}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#tags SagemakerNotebookInstance#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#tags_all SagemakerNotebookInstance#tags_all}.
volumeSize	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#volume_size SagemakerNotebookInstance#volume_size}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

instanceType^Required

public readonly instanceType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#instance_type SagemakerNotebookInstance#instance_type}.

---

name^Required

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#name SagemakerNotebookInstance#name}.

---

roleArn^Required

public readonly roleArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#role_arn SagemakerNotebookInstance#role_arn}.

---

acceleratorTypes^Optional

public readonly acceleratorTypes: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#accelerator_types SagemakerNotebookInstance#accelerator_types}.

---

additionalCodeRepositories^Optional

public readonly additionalCodeRepositories: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#additional_code_repositories SagemakerNotebookInstance#additional_code_repositories}.

---

defaultCodeRepository^Optional

public readonly defaultCodeRepository: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#default_code_repository SagemakerNotebookInstance#default_code_repository}.

---

directInternetAccess^Optional

public readonly directInternetAccess: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#direct_internet_access SagemakerNotebookInstance#direct_internet_access}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#id SagemakerNotebookInstance#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

instanceMetadataServiceConfiguration^Optional

public readonly instanceMetadataServiceConfiguration: SagemakerNotebookInstanceInstanceMetadataServiceConfiguration;

• Type: SagemakerNotebookInstanceInstanceMetadataServiceConfiguration

instance_metadata_service_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#instance_metadata_service_configuration SagemakerNotebookInstance#instance_metadata_service_configuration}

---

kmsKeyId^Optional

public readonly kmsKeyId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#kms_key_id SagemakerNotebookInstance#kms_key_id}.

---

lifecycleConfigName^Optional

public readonly lifecycleConfigName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#lifecycle_config_name SagemakerNotebookInstance#lifecycle_config_name}.

---

platformIdentifier^Optional

public readonly platformIdentifier: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#platform_identifier SagemakerNotebookInstance#platform_identifier}.

---

rootAccess^Optional

public readonly rootAccess: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#root_access SagemakerNotebookInstance#root_access}.

---

securityGroups^Optional

public readonly securityGroups: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#security_groups SagemakerNotebookInstance#security_groups}.

---

subnetId^Optional

public readonly subnetId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#subnet_id SagemakerNotebookInstance#subnet_id}.

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#tags SagemakerNotebookInstance#tags}.

---

tagsAll^Optional

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#tags_all SagemakerNotebookInstance#tags_all}.

---

volumeSize^Optional

public readonly volumeSize: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#volume_size SagemakerNotebookInstance#volume_size}.

---

SagemakerNotebookInstanceInstanceMetadataServiceConfiguration

Initializer

import { sagemakerNotebookInstance } from '@cdktf/provider-aws'

const sagemakerNotebookInstanceInstanceMetadataServiceConfiguration: sagemakerNotebookInstance.SagemakerNotebookInstanceInstanceMetadataServiceConfiguration = { ... }

Properties

Name	Type	Description
minimumInstanceMetadataServiceVersion	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#minimum_instance_metadata_service_version SagemakerNotebookInstance#minimum_instance_metadata_service_version}.

---

minimumInstanceMetadataServiceVersion^Optional

public readonly minimumInstanceMetadataServiceVersion: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/sagemaker_notebook_instance#minimum_instance_metadata_service_version SagemakerNotebookInstance#minimum_instance_metadata_service_version}.

---

Classes

SagemakerNotebookInstanceInstanceMetadataServiceConfigurationOutputReference

Initializers

import { sagemakerNotebookInstance } from '@cdktf/provider-aws'

new sagemakerNotebookInstance.SagemakerNotebookInstanceInstanceMetadataServiceConfigurationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetMinimumInstanceMetadataServiceVersion	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetMinimumInstanceMetadataServiceVersion

public resetMinimumInstanceMetadataServiceVersion(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
minimumInstanceMetadataServiceVersionInput	string	No description.
minimumInstanceMetadataServiceVersion	string	No description.
internalValue	SagemakerNotebookInstanceInstanceMetadataServiceConfiguration	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

minimumInstanceMetadataServiceVersionInput^Optional

public readonly minimumInstanceMetadataServiceVersionInput: string;

• Type: string

---

minimumInstanceMetadataServiceVersion^Required

public readonly minimumInstanceMetadataServiceVersion: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: SagemakerNotebookInstanceInstanceMetadataServiceConfiguration;

• Type: SagemakerNotebookInstanceInstanceMetadataServiceConfiguration

---