Package com.pulumi.aws.sagemaker.inputs

Class NotebookInstanceState

  • public final class NotebookInstanceState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  NotebookInstanceState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Detail

      • additionalCodeRepositories

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> additionalCodeRepositories()
        Returns:
        An array of up to three Git repositories to associate 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](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN assigned by AWS to this notebook instance.

      • defaultCodeRepository

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> defaultCodeRepository()
        Returns:
        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](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository.

      • directInternetAccess

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> directInternetAccess()
        Returns:
        Set to `Disabled` to disable internet access to notebook. Requires `securityGroups` and `subnetId` 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 AI training and endpoint services unless your configure a NAT Gateway in your VPC.

      • instanceMetadataServiceConfiguration

        public java.util.Optional<com.pulumi.core.Output<NotebookInstanceInstanceMetadataServiceConfigurationArgs>> instanceMetadataServiceConfiguration()
        Returns:
        Information on the IMDS configuration of the notebook instance. Conflicts with `instanceMetadataServiceConfiguration`. see details below.

      • instanceType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> instanceType()
        Returns:
        The name of ML compute instance type.

      • kmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
        Returns:
        KMS key that Amazon SageMaker AI uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

      • lifecycleConfigName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> lifecycleConfigName()
        Returns:
        The name of a lifecycle configuration to associate with the notebook instance.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        The name of the notebook instance (must be unique).

      • networkInterfaceId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkInterfaceId()
        Returns:
        The network interface ID that Amazon SageMaker AI created at the time of creating the instance. Only available when setting `subnetId`.

      • platformIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> platformIdentifier()
        Returns:
        The platform identifier of the notebook instance runtime environment. This value can be either `notebook-al1-v1`(deprecated), `notebook-al2-v1`(deprecated), `notebook-al2-v2`(deprecated), `notebook-al2-v3`, or `notebook-al2023-v1`, depending on which version of Amazon Linux you require. Defaults to `notebook-al2-v3`.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • roleArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> roleArn()
        Returns:
        The ARN of the IAM role to be used by the notebook instance which allows SageMaker AI to call other services on your behalf.

      • rootAccess

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> rootAccess()
        Returns:
        Whether root access is `Enabled` or `Disabled` for users of the notebook instance. The default value is `Enabled`.

      • securityGroups

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> securityGroups()
        Returns:
        The associated security groups.

      • subnetId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> subnetId()
        Returns:
        The VPC subnet ID.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • url

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> url()
        Returns:
        The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

      • volumeSize

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> volumeSize()
        Returns:
        The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.