public static interface CfnUserProfile.UserSettingsProperty
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnUserProfile.UserSettingsProperty.Builder
A builder for
CfnUserProfile.UserSettingsProperty |
static class |
CfnUserProfile.UserSettingsProperty.Jsii$Proxy
An implementation for
CfnUserProfile.UserSettingsProperty |
Modifier and Type | Method and Description |
---|---|
static CfnUserProfile.UserSettingsProperty.Builder |
builder() |
default java.lang.String |
getExecutionRole()
The execution role for the user.
|
default java.lang.Object |
getJupyterServerAppSettings()
The Jupyter server's app settings.
|
default java.lang.Object |
getKernelGatewayAppSettings()
The kernel gateway app settings.
|
default java.lang.Object |
getRStudioServerProAppSettings()
A collection of settings that configure user interaction with the `RStudioServerPro` app.
|
default java.util.List<java.lang.String> |
getSecurityGroups()
The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
|
default java.lang.Object |
getSharingSettings()
Specifies options for sharing SageMaker Studio notebooks.
|
default java.lang.String getExecutionRole()
default java.lang.Object getJupyterServerAppSettings()
default java.lang.Object getKernelGatewayAppSettings()
default java.lang.Object getRStudioServerProAppSettings()
default java.util.List<java.lang.String> getSecurityGroups()
Optional when the CreateDomain.AppNetworkAccessType
parameter is set to PublicInternetOnly
.
Required when the CreateDomain.AppNetworkAccessType
parameter is set to VpcOnly
.
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.
default java.lang.Object getSharingSettings()
static CfnUserProfile.UserSettingsProperty.Builder builder()