Interface CfnDomain.DefaultSpaceSettingsProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDomain.DefaultSpaceSettingsProperty.Jsii$Proxy
- Enclosing class:
CfnDomain
@Stability(Stable)
public static interface CfnDomain.DefaultSpaceSettingsProperty
extends software.amazon.jsii.JsiiSerializable
The default settings for shared spaces that users create in the domain.
SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.
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.*;
DefaultSpaceSettingsProperty defaultSpaceSettingsProperty = DefaultSpaceSettingsProperty.builder()
.executionRole("executionRole")
// the properties below are optional
.customFileSystemConfigs(List.of(CustomFileSystemConfigProperty.builder()
.efsFileSystemConfig(EFSFileSystemConfigProperty.builder()
.fileSystemId("fileSystemId")
// the properties below are optional
.fileSystemPath("fileSystemPath")
.build())
.fSxLustreFileSystemConfig(FSxLustreFileSystemConfigProperty.builder()
.fileSystemId("fileSystemId")
// the properties below are optional
.fileSystemPath("fileSystemPath")
.build())
.s3FileSystemConfig(S3FileSystemConfigProperty.builder()
.mountPath("mountPath")
.s3Uri("s3Uri")
.build())
.build()))
.customPosixUserConfig(CustomPosixUserConfigProperty.builder()
.gid(123)
.uid(123)
.build())
.jupyterLabAppSettings(JupyterLabAppSettingsProperty.builder()
.appLifecycleManagement(AppLifecycleManagementProperty.builder()
.idleSettings(IdleSettingsProperty.builder()
.idleTimeoutInMinutes(123)
.lifecycleManagement("lifecycleManagement")
.maxIdleTimeoutInMinutes(123)
.minIdleTimeoutInMinutes(123)
.build())
.build())
.builtInLifecycleConfigArn("builtInLifecycleConfigArn")
.codeRepositories(List.of(CodeRepositoryProperty.builder()
.repositoryUrl("repositoryUrl")
.build()))
.customImages(List.of(CustomImageProperty.builder()
.appImageConfigName("appImageConfigName")
.imageName("imageName")
// the properties below are optional
.imageVersionNumber(123)
.build()))
.defaultResourceSpec(ResourceSpecProperty.builder()
.instanceType("instanceType")
.lifecycleConfigArn("lifecycleConfigArn")
.sageMakerImageArn("sageMakerImageArn")
.sageMakerImageVersionArn("sageMakerImageVersionArn")
.build())
.lifecycleConfigArns(List.of("lifecycleConfigArns"))
.build())
.jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
.defaultResourceSpec(ResourceSpecProperty.builder()
.instanceType("instanceType")
.lifecycleConfigArn("lifecycleConfigArn")
.sageMakerImageArn("sageMakerImageArn")
.sageMakerImageVersionArn("sageMakerImageVersionArn")
.build())
.lifecycleConfigArns(List.of("lifecycleConfigArns"))
.build())
.kernelGatewayAppSettings(KernelGatewayAppSettingsProperty.builder()
.customImages(List.of(CustomImageProperty.builder()
.appImageConfigName("appImageConfigName")
.imageName("imageName")
// the properties below are optional
.imageVersionNumber(123)
.build()))
.defaultResourceSpec(ResourceSpecProperty.builder()
.instanceType("instanceType")
.lifecycleConfigArn("lifecycleConfigArn")
.sageMakerImageArn("sageMakerImageArn")
.sageMakerImageVersionArn("sageMakerImageVersionArn")
.build())
.lifecycleConfigArns(List.of("lifecycleConfigArns"))
.build())
.securityGroups(List.of("securityGroups"))
.spaceStorageSettings(DefaultSpaceStorageSettingsProperty.builder()
.defaultEbsStorageSettings(DefaultEbsStorageSettingsProperty.builder()
.defaultEbsVolumeSizeInGb(123)
.maximumEbsVolumeSizeInGb(123)
.build())
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDomain.DefaultSpaceSettingsPropertystatic final classAn implementation forCfnDomain.DefaultSpaceSettingsProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe settings for assigning a custom file system to a domain.default ObjectReturns union: eitherIResolvableorCfnDomain.CustomPosixUserConfigPropertyThe ARN of the execution role for the space.default ObjectThe JupyterLab app settings.default ObjectThe JupyterServer app settings.default ObjectThe KernelGateway app settings.The security group IDs for the Amazon VPC that the space uses for communication.default ObjectDefault storage settings for a space.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getExecutionRole
The ARN of the execution role for the space.- See Also:
-
getCustomFileSystemConfigs
The settings for assigning a custom file system to a domain.Permitted users can access this file system in Amazon SageMaker AI Studio.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDomain.CustomFileSystemConfigProperty>- See Also:
-
getCustomPosixUserConfig
Returns union: eitherIResolvableorCfnDomain.CustomPosixUserConfigProperty- See Also:
-
getJupyterLabAppSettings
The JupyterLab app settings.Returns union: either
IResolvableorCfnDomain.JupyterLabAppSettingsProperty- See Also:
-
getJupyterServerAppSettings
The JupyterServer app settings.Returns union: either
IResolvableorCfnDomain.JupyterServerAppSettingsProperty- See Also:
-
getKernelGatewayAppSettings
The KernelGateway app settings.Returns union: either
IResolvableorCfnDomain.KernelGatewayAppSettingsProperty- See Also:
-
getSecurityGroups
The security group IDs for the Amazon VPC that the space uses for communication.- See Also:
-
getSpaceStorageSettings
Default storage settings for a space.Returns union: either
IResolvableorCfnDomain.DefaultSpaceStorageSettingsProperty- See Also:
-
builder
-