Package software.amazon.awscdk.services.sagemaker

Interface CfnUserProfile.UserSettingsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnUserProfile.UserSettingsProperty.Jsii$Proxy
Enclosing class:
CfnUserProfile
@Stability(Stable) public static interface CfnUserProfile.UserSettingsProperty extends software.amazon.jsii.JsiiSerializable
A collection of settings that apply to users of Amazon SageMaker Studio.

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()
         .codeEditorAppSettings(CodeEditorAppSettingsProperty.builder()
                 .defaultResourceSpec(ResourceSpecProperty.builder()
                         .instanceType("instanceType")
                         .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")
         .executionRole("executionRole")
         .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")
                         .sageMakerImageArn("sageMakerImageArn")
                         .sageMakerImageVersionArn("sageMakerImageVersionArn")
                         .build())
                 .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                 .build())
         .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                 .defaultResourceSpec(ResourceSpecProperty.builder()
                         .instanceType("instanceType")
                         .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")
                         .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: