Class CfnSpacePropsMixin.SpaceSettingsProperty

A collection of space settings.

Inheritance

object

CfnSpacePropsMixin.SpaceSettingsProperty

Implements

CfnSpacePropsMixin.ISpaceSettingsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnSpacePropsMixin.SpaceSettingsProperty : CfnSpacePropsMixin.ISpaceSettingsProperty

Syntax (vb)

Public Class CfnSpacePropsMixin.SpaceSettingsProperty Implements CfnSpacePropsMixin.ISpaceSettingsProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins;

             var spaceSettingsProperty = new SpaceSettingsProperty {
                 AppType = "appType",
                 CodeEditorAppSettings = new SpaceCodeEditorAppSettingsProperty {
                     AppLifecycleManagement = new SpaceAppLifecycleManagementProperty {
                         IdleSettings = new SpaceIdleSettingsProperty {
                             IdleTimeoutInMinutes = 123
                         }
                     },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     }
                 },
                 CustomFileSystems = new [] { new CustomFileSystemProperty {
                     EfsFileSystem = new EFSFileSystemProperty {
                         FileSystemId = "fileSystemId"
                     },
                     FSxLustreFileSystem = new FSxLustreFileSystemProperty {
                         FileSystemId = "fileSystemId"
                     },
                     S3FileSystem = new S3FileSystemProperty {
                         S3Uri = "s3Uri"
                     }
                 } },
                 JupyterLabAppSettings = new SpaceJupyterLabAppSettingsProperty {
                     AppLifecycleManagement = new SpaceAppLifecycleManagementProperty {
                         IdleSettings = new SpaceIdleSettingsProperty {
                             IdleTimeoutInMinutes = 123
                         }
                     },
                     CodeRepositories = new [] { new CodeRepositoryProperty {
                         RepositoryUrl = "repositoryUrl"
                     } },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     }
                 },
                 JupyterServerAppSettings = new JupyterServerAppSettingsProperty {
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 KernelGatewayAppSettings = new KernelGatewayAppSettingsProperty {
                     CustomImages = new [] { new CustomImageProperty {
                         AppImageConfigName = "appImageConfigName",
                         ImageName = "imageName",
                         ImageVersionNumber = 123
                     } },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 RemoteAccess = "remoteAccess",
                 SpaceManagedResources = "spaceManagedResources",
                 SpaceStorageSettings = new SpaceStorageSettingsProperty {
                     EbsStorageSettings = new EbsStorageSettingsProperty {
                         EbsVolumeSizeInGb = 123
                     }
                 }
             };

Synopsis

Constructors

SpaceSettingsProperty()

A collection of space settings.

Properties

AppType	The type of app created within the space.
CodeEditorAppSettings	The Code Editor application settings.
CustomFileSystems	A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain.
JupyterLabAppSettings	The settings for the JupyterLab application.
JupyterServerAppSettings	The JupyterServer app settings.
KernelGatewayAppSettings	The KernelGateway app settings.
RemoteAccess	A setting that enables or disables remote access for a SageMaker space.
SpaceManagedResources	If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:.
SpaceStorageSettings	The storage settings for a space.

Constructors

SpaceSettingsProperty()

A collection of space settings.

public SpaceSettingsProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins;

             var spaceSettingsProperty = new SpaceSettingsProperty {
                 AppType = "appType",
                 CodeEditorAppSettings = new SpaceCodeEditorAppSettingsProperty {
                     AppLifecycleManagement = new SpaceAppLifecycleManagementProperty {
                         IdleSettings = new SpaceIdleSettingsProperty {
                             IdleTimeoutInMinutes = 123
                         }
                     },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     }
                 },
                 CustomFileSystems = new [] { new CustomFileSystemProperty {
                     EfsFileSystem = new EFSFileSystemProperty {
                         FileSystemId = "fileSystemId"
                     },
                     FSxLustreFileSystem = new FSxLustreFileSystemProperty {
                         FileSystemId = "fileSystemId"
                     },
                     S3FileSystem = new S3FileSystemProperty {
                         S3Uri = "s3Uri"
                     }
                 } },
                 JupyterLabAppSettings = new SpaceJupyterLabAppSettingsProperty {
                     AppLifecycleManagement = new SpaceAppLifecycleManagementProperty {
                         IdleSettings = new SpaceIdleSettingsProperty {
                             IdleTimeoutInMinutes = 123
                         }
                     },
                     CodeRepositories = new [] { new CodeRepositoryProperty {
                         RepositoryUrl = "repositoryUrl"
                     } },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     }
                 },
                 JupyterServerAppSettings = new JupyterServerAppSettingsProperty {
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 KernelGatewayAppSettings = new KernelGatewayAppSettingsProperty {
                     CustomImages = new [] { new CustomImageProperty {
                         AppImageConfigName = "appImageConfigName",
                         ImageName = "imageName",
                         ImageVersionNumber = 123
                     } },
                     DefaultResourceSpec = new ResourceSpecProperty {
                         InstanceType = "instanceType",
                         LifecycleConfigArn = "lifecycleConfigArn",
                         SageMakerImageArn = "sageMakerImageArn",
                         SageMakerImageVersionArn = "sageMakerImageVersionArn"
                     },
                     LifecycleConfigArns = new [] { "lifecycleConfigArns" }
                 },
                 RemoteAccess = "remoteAccess",
                 SpaceManagedResources = "spaceManagedResources",
                 SpaceStorageSettings = new SpaceStorageSettingsProperty {
                     EbsStorageSettings = new EbsStorageSettingsProperty {
                         EbsVolumeSizeInGb = 123
                     }
                 }
             };

Properties

AppType

The type of app created within the space.

public string? AppType { get; set; }

Property Value

string

Remarks

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-apptype

CodeEditorAppSettings

The Code Editor application settings.

public object? CodeEditorAppSettings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-codeeditorappsettings

Type union: either IResolvable or CfnSpacePropsMixin.ISpaceCodeEditorAppSettingsProperty

CustomFileSystems

A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain.

public object? CustomFileSystems { get; set; }

Property Value

object

Remarks

Permitted users can access this file system in Amazon SageMaker AI Studio.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-customfilesystems

Type union: either IResolvable or (either IResolvable or CfnSpacePropsMixin.ICustomFileSystemProperty)[]

JupyterLabAppSettings

The settings for the JupyterLab application.

public object? JupyterLabAppSettings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-jupyterlabappsettings

Type union: either IResolvable or CfnSpacePropsMixin.ISpaceJupyterLabAppSettingsProperty

JupyterServerAppSettings

The JupyterServer app settings.

public object? JupyterServerAppSettings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-jupyterserverappsettings

Type union: either IResolvable or CfnSpacePropsMixin.IJupyterServerAppSettingsProperty

KernelGatewayAppSettings

The KernelGateway app settings.

public object? KernelGatewayAppSettings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-kernelgatewayappsettings

Type union: either IResolvable or CfnSpacePropsMixin.IKernelGatewayAppSettingsProperty

RemoteAccess

A setting that enables or disables remote access for a SageMaker space.

public string? RemoteAccess { get; set; }

Property Value

string

Remarks

When enabled, this allows you to connect to the remote space from your local IDE.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-remoteaccess

SpaceManagedResources

If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:.

public string? SpaceManagedResources { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-spacemanagedresources

SpaceStorageSettings

The storage settings for a space.

public object? SpaceStorageSettings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-spacestoragesettings

Type union: either IResolvable or CfnSpacePropsMixin.ISpaceStorageSettingsProperty

Implements

CfnSpacePropsMixin.ISpaceSettingsProperty