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()
         .executionRole("executionRole")
         .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())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserProfile.UserSettingsProperty.Builder	A builder for CfnUserProfile.UserSettingsProperty
static final class	CfnUserProfile.UserSettingsProperty.Jsii$Proxy	An implementation for CfnUserProfile.UserSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserProfile.UserSettingsProperty.Builder	builder()
default String	getExecutionRole()	The execution role for the user.
default Object	getJupyterServerAppSettings()	The Jupyter server's app settings.
default Object	getKernelGatewayAppSettings()	The kernel gateway app settings.
default Object	getRStudioServerProAppSettings()	A collection of settings that configure user interaction with the RStudioServerPro app.
default List<String>	getSecurityGroups()	The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
default Object	getSharingSettings()	Specifies options for sharing SageMaker Studio notebooks.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionRole

@Stability(Stable)
@Nullable
default String getExecutionRole()

The execution role for the user.

getJupyterServerAppSettings

@Stability(Stable)
@Nullable
default Object getJupyterServerAppSettings()

The Jupyter server's app settings.

getKernelGatewayAppSettings

@Stability(Stable)
@Nullable
default Object getKernelGatewayAppSettings()

The kernel gateway app settings.

getRStudioServerProAppSettings

@Stability(Stable)
@Nullable
default Object getRStudioServerProAppSettings()

A collection of settings that configure user interaction with the RStudioServerPro app.

getSecurityGroups

@Stability(Stable)
@Nullable
default List<String> getSecurityGroups()

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

getSharingSettings

@Stability(Stable)
@Nullable
default Object getSharingSettings()

Specifies options for sharing SageMaker Studio notebooks.

builder

@Stability(Stable)
static CfnUserProfile.UserSettingsProperty.Builder builder()

Returns:

a CfnUserProfile.UserSettingsProperty.Builder of CfnUserProfile.UserSettingsProperty