Interface CfnDomain.UserSettingsProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDomain.UserSettingsProperty.Jsii$Proxy
- Enclosing class:
CfnDomain
These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings
when the CreateDomain API is called.
SecurityGroups
is aggregated when specified in both calls. For all other settings in UserSettings
, the values specified in CreateUserProfile
take precedence over those specified in CreateDomain
.
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.*; UserSettingsProperty userSettingsProperty = UserSettingsProperty.builder() .executionRole("executionRole") // the properties below are optional .codeEditorAppSettings(CodeEditorAppSettingsProperty.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()) .customFileSystemConfigs(List.of(CustomFileSystemConfigProperty.builder() .efsFileSystemConfig(EFSFileSystemConfigProperty.builder() .fileSystemId("fileSystemId") // the properties below are optional .fileSystemPath("fileSystemPath") .build()) .build())) .customPosixUserConfig(CustomPosixUserConfigProperty.builder() .gid(123) .uid(123) .build()) .defaultLandingUri("defaultLandingUri") .jupyterLabAppSettings(JupyterLabAppSettingsProperty.builder() .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()) .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()) .build()) .rSessionAppSettings(RSessionAppSettingsProperty.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()) .build()) .rStudioServerProAppSettings(RStudioServerProAppSettingsProperty.builder() .accessStatus("accessStatus") .userGroup("userGroup") .build()) .securityGroups(List.of("securityGroups")) .sharingSettings(SharingSettingsProperty.builder() .notebookOutputOption("notebookOutputOption") .s3KmsKeyId("s3KmsKeyId") .s3OutputPath("s3OutputPath") .build()) .spaceStorageSettings(DefaultSpaceStorageSettingsProperty.builder() .defaultEbsStorageSettings(DefaultEbsStorageSettingsProperty.builder() .defaultEbsVolumeSizeInGb(123) .maximumEbsVolumeSizeInGb(123) .build()) .build()) .studioWebPortal("studioWebPortal") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDomain.UserSettingsProperty
static final class
An implementation forCfnDomain.UserSettingsProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The Code Editor application settings.default Object
The settings for assigning a custom file system to a user profile.default Object
Details about the POSIX identity that is used for file system operations.default String
The default experience that the user is directed to when accessing the domain.The execution role for the user.default Object
The settings for the JupyterLab application.default Object
The Jupyter server's app settings.default Object
The kernel gateway app settings.default Object
A collection of settings that configure theRSessionGateway
app.default Object
A collection of settings that configure user interaction with theRStudioServerPro
app.The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.default Object
Specifies options for sharing Amazon SageMaker Studio notebooks.default Object
The storage settings for a private space.default String
Whether the user can access Studio.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getExecutionRole
The execution role for the user.- See Also:
-
getCodeEditorAppSettings
The Code Editor application settings.- See Also:
-
getCustomFileSystemConfigs
The settings for assigning a custom file system to a user profile.Permitted users can access this file system in Amazon SageMaker Studio.
- See Also:
-
getCustomPosixUserConfig
Details about the POSIX identity that is used for file system operations.- See Also:
-
getDefaultLandingUri
The default experience that the user is directed to when accessing the domain. The supported values are:.studio::
: Indicates that Studio is the default experience. This value can only be passed ifStudioWebPortal
is set toENABLED
.app:JupyterServer:
: Indicates that Studio Classic is the default experience.
- See Also:
-
getJupyterLabAppSettings
The settings for the JupyterLab application.- See Also:
-
getJupyterServerAppSettings
The Jupyter server's app settings.- See Also:
-
getKernelGatewayAppSettings
The kernel gateway app settings.- See Also:
-
getRSessionAppSettings
A collection of settings that configure theRSessionGateway
app.- See Also:
-
getRStudioServerProAppSettings
A collection of settings that configure user interaction with theRStudioServerPro
app.- See Also:
-
getSecurityGroups
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.Optional when the
CreateDomain.AppNetworkAccessType
parameter is set toPublicInternetOnly
.Required when the
CreateDomain.AppNetworkAccessType
parameter is set toVpcOnly
, unless specified as part of theDefaultUserSettings
for the domain.Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
- See Also:
-
getSharingSettings
Specifies options for sharing Amazon SageMaker Studio notebooks.- See Also:
-
getSpaceStorageSettings
The storage settings for a private space.- See Also:
-
getStudioWebPortal
Whether the user can access Studio.If this value is set to
DISABLED
, the user cannot access Studio, even if that is the default experience for the domain.- See Also:
-
builder
-