com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsArgs Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.sagemaker.inputs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsCanvasAppSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsCodeEditorAppSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsCustomFileSystemConfigArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsCustomPosixUserConfigArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsJupyterLabAppSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsJupyterServerAppSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsKernelGatewayAppSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsRSessionAppSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsRStudioServerProAppSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsSharingSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsSpaceStorageSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsStudioWebPortalSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.UserProfileUserSettingsTensorBoardAppSettingsArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class UserProfileUserSettingsArgs extends com.pulumi.resources.ResourceArgs {
public static final UserProfileUserSettingsArgs Empty = new UserProfileUserSettingsArgs();
/**
* Indicates whether auto-mounting of an EFS volume is supported for the user profile. The `DefaultAsDomain` value is only supported for user profiles. Do not use the `DefaultAsDomain` value when setting this parameter for a domain. Valid values are: `Enabled`, `Disabled`, and `DefaultAsDomain`.
*
*/
@Import(name="autoMountHomeEfs")
private @Nullable Output autoMountHomeEfs;
/**
* @return Indicates whether auto-mounting of an EFS volume is supported for the user profile. The `DefaultAsDomain` value is only supported for user profiles. Do not use the `DefaultAsDomain` value when setting this parameter for a domain. Valid values are: `Enabled`, `Disabled`, and `DefaultAsDomain`.
*
*/
public Optional> autoMountHomeEfs() {
return Optional.ofNullable(this.autoMountHomeEfs);
}
/**
* The Canvas app settings. See Canvas App Settings below.
*
*/
@Import(name="canvasAppSettings")
private @Nullable Output canvasAppSettings;
/**
* @return The Canvas app settings. See Canvas App Settings below.
*
*/
public Optional> canvasAppSettings() {
return Optional.ofNullable(this.canvasAppSettings);
}
/**
* The Code Editor application settings. See Code Editor App Settings below.
*
*/
@Import(name="codeEditorAppSettings")
private @Nullable Output codeEditorAppSettings;
/**
* @return The Code Editor application settings. See Code Editor App Settings below.
*
*/
public Optional> codeEditorAppSettings() {
return Optional.ofNullable(this.codeEditorAppSettings);
}
/**
* The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio. See Custom File System Config below.
*
*/
@Import(name="customFileSystemConfigs")
private @Nullable Output> customFileSystemConfigs;
/**
* @return The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio. See Custom File System Config below.
*
*/
public Optional>> customFileSystemConfigs() {
return Optional.ofNullable(this.customFileSystemConfigs);
}
/**
* Details about the POSIX identity that is used for file system operations. See Custom Posix User Config below.
*
*/
@Import(name="customPosixUserConfig")
private @Nullable Output customPosixUserConfig;
/**
* @return Details about the POSIX identity that is used for file system operations. See Custom Posix User Config below.
*
*/
public Optional> customPosixUserConfig() {
return Optional.ofNullable(this.customPosixUserConfig);
}
/**
* 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 if StudioWebPortal is set to ENABLED. `app:JupyterServer:`: Indicates that Studio Classic is the default experience.
*
*/
@Import(name="defaultLandingUri")
private @Nullable Output defaultLandingUri;
/**
* @return 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 if StudioWebPortal is set to ENABLED. `app:JupyterServer:`: Indicates that Studio Classic is the default experience.
*
*/
public Optional> defaultLandingUri() {
return Optional.ofNullable(this.defaultLandingUri);
}
/**
* The execution role ARN for the user.
*
*/
@Import(name="executionRole", required=true)
private Output executionRole;
/**
* @return The execution role ARN for the user.
*
*/
public Output executionRole() {
return this.executionRole;
}
/**
* The settings for the JupyterLab application. See Jupyter Lab App Settings below.
*
*/
@Import(name="jupyterLabAppSettings")
private @Nullable Output jupyterLabAppSettings;
/**
* @return The settings for the JupyterLab application. See Jupyter Lab App Settings below.
*
*/
public Optional> jupyterLabAppSettings() {
return Optional.ofNullable(this.jupyterLabAppSettings);
}
/**
* The Jupyter server's app settings. See Jupyter Server App Settings below.
*
*/
@Import(name="jupyterServerAppSettings")
private @Nullable Output jupyterServerAppSettings;
/**
* @return The Jupyter server's app settings. See Jupyter Server App Settings below.
*
*/
public Optional> jupyterServerAppSettings() {
return Optional.ofNullable(this.jupyterServerAppSettings);
}
/**
* The kernel gateway app settings. See Kernel Gateway App Settings below.
*
*/
@Import(name="kernelGatewayAppSettings")
private @Nullable Output kernelGatewayAppSettings;
/**
* @return The kernel gateway app settings. See Kernel Gateway App Settings below.
*
*/
public Optional> kernelGatewayAppSettings() {
return Optional.ofNullable(this.kernelGatewayAppSettings);
}
/**
* The RSession app settings. See RSession App Settings below.
*
*/
@Import(name="rSessionAppSettings")
private @Nullable Output rSessionAppSettings;
/**
* @return The RSession app settings. See RSession App Settings below.
*
*/
public Optional> rSessionAppSettings() {
return Optional.ofNullable(this.rSessionAppSettings);
}
/**
* A collection of settings that configure user interaction with the RStudioServerPro app. See RStudioServerProAppSettings below.
*
*/
@Import(name="rStudioServerProAppSettings")
private @Nullable Output rStudioServerProAppSettings;
/**
* @return A collection of settings that configure user interaction with the RStudioServerPro app. See RStudioServerProAppSettings below.
*
*/
public Optional> rStudioServerProAppSettings() {
return Optional.ofNullable(this.rStudioServerProAppSettings);
}
/**
* A list of security group IDs that will be attached to the user.
*
*/
@Import(name="securityGroups")
private @Nullable Output> securityGroups;
/**
* @return A list of security group IDs that will be attached to the user.
*
*/
public Optional>> securityGroups() {
return Optional.ofNullable(this.securityGroups);
}
/**
* The sharing settings. See Sharing Settings below.
*
*/
@Import(name="sharingSettings")
private @Nullable Output sharingSettings;
/**
* @return The sharing settings. See Sharing Settings below.
*
*/
public Optional> sharingSettings() {
return Optional.ofNullable(this.sharingSettings);
}
/**
* The storage settings for a private space. See Space Storage Settings below.
*
*/
@Import(name="spaceStorageSettings")
private @Nullable Output spaceStorageSettings;
/**
* @return The storage settings for a private space. See Space Storage Settings below.
*
*/
public Optional> spaceStorageSettings() {
return Optional.ofNullable(this.spaceStorageSettings);
}
/**
* 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. Valid values are `ENABLED` and `DISABLED`.
*
*/
@Import(name="studioWebPortal")
private @Nullable Output studioWebPortal;
/**
* @return 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. Valid values are `ENABLED` and `DISABLED`.
*
*/
public Optional> studioWebPortal() {
return Optional.ofNullable(this.studioWebPortal);
}
/**
* The Studio Web Portal settings. See `studio_web_portal_settings` Block below.
*
*/
@Import(name="studioWebPortalSettings")
private @Nullable Output studioWebPortalSettings;
/**
* @return The Studio Web Portal settings. See `studio_web_portal_settings` Block below.
*
*/
public Optional> studioWebPortalSettings() {
return Optional.ofNullable(this.studioWebPortalSettings);
}
/**
* The TensorBoard app settings. See TensorBoard App Settings below.
*
*/
@Import(name="tensorBoardAppSettings")
private @Nullable Output tensorBoardAppSettings;
/**
* @return The TensorBoard app settings. See TensorBoard App Settings below.
*
*/
public Optional> tensorBoardAppSettings() {
return Optional.ofNullable(this.tensorBoardAppSettings);
}
private UserProfileUserSettingsArgs() {}
private UserProfileUserSettingsArgs(UserProfileUserSettingsArgs $) {
this.autoMountHomeEfs = $.autoMountHomeEfs;
this.canvasAppSettings = $.canvasAppSettings;
this.codeEditorAppSettings = $.codeEditorAppSettings;
this.customFileSystemConfigs = $.customFileSystemConfigs;
this.customPosixUserConfig = $.customPosixUserConfig;
this.defaultLandingUri = $.defaultLandingUri;
this.executionRole = $.executionRole;
this.jupyterLabAppSettings = $.jupyterLabAppSettings;
this.jupyterServerAppSettings = $.jupyterServerAppSettings;
this.kernelGatewayAppSettings = $.kernelGatewayAppSettings;
this.rSessionAppSettings = $.rSessionAppSettings;
this.rStudioServerProAppSettings = $.rStudioServerProAppSettings;
this.securityGroups = $.securityGroups;
this.sharingSettings = $.sharingSettings;
this.spaceStorageSettings = $.spaceStorageSettings;
this.studioWebPortal = $.studioWebPortal;
this.studioWebPortalSettings = $.studioWebPortalSettings;
this.tensorBoardAppSettings = $.tensorBoardAppSettings;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(UserProfileUserSettingsArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private UserProfileUserSettingsArgs $;
public Builder() {
$ = new UserProfileUserSettingsArgs();
}
public Builder(UserProfileUserSettingsArgs defaults) {
$ = new UserProfileUserSettingsArgs(Objects.requireNonNull(defaults));
}
/**
* @param autoMountHomeEfs Indicates whether auto-mounting of an EFS volume is supported for the user profile. The `DefaultAsDomain` value is only supported for user profiles. Do not use the `DefaultAsDomain` value when setting this parameter for a domain. Valid values are: `Enabled`, `Disabled`, and `DefaultAsDomain`.
*
* @return builder
*
*/
public Builder autoMountHomeEfs(@Nullable Output autoMountHomeEfs) {
$.autoMountHomeEfs = autoMountHomeEfs;
return this;
}
/**
* @param autoMountHomeEfs Indicates whether auto-mounting of an EFS volume is supported for the user profile. The `DefaultAsDomain` value is only supported for user profiles. Do not use the `DefaultAsDomain` value when setting this parameter for a domain. Valid values are: `Enabled`, `Disabled`, and `DefaultAsDomain`.
*
* @return builder
*
*/
public Builder autoMountHomeEfs(String autoMountHomeEfs) {
return autoMountHomeEfs(Output.of(autoMountHomeEfs));
}
/**
* @param canvasAppSettings The Canvas app settings. See Canvas App Settings below.
*
* @return builder
*
*/
public Builder canvasAppSettings(@Nullable Output canvasAppSettings) {
$.canvasAppSettings = canvasAppSettings;
return this;
}
/**
* @param canvasAppSettings The Canvas app settings. See Canvas App Settings below.
*
* @return builder
*
*/
public Builder canvasAppSettings(UserProfileUserSettingsCanvasAppSettingsArgs canvasAppSettings) {
return canvasAppSettings(Output.of(canvasAppSettings));
}
/**
* @param codeEditorAppSettings The Code Editor application settings. See Code Editor App Settings below.
*
* @return builder
*
*/
public Builder codeEditorAppSettings(@Nullable Output codeEditorAppSettings) {
$.codeEditorAppSettings = codeEditorAppSettings;
return this;
}
/**
* @param codeEditorAppSettings The Code Editor application settings. See Code Editor App Settings below.
*
* @return builder
*
*/
public Builder codeEditorAppSettings(UserProfileUserSettingsCodeEditorAppSettingsArgs codeEditorAppSettings) {
return codeEditorAppSettings(Output.of(codeEditorAppSettings));
}
/**
* @param customFileSystemConfigs The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio. See Custom File System Config below.
*
* @return builder
*
*/
public Builder customFileSystemConfigs(@Nullable Output> customFileSystemConfigs) {
$.customFileSystemConfigs = customFileSystemConfigs;
return this;
}
/**
* @param customFileSystemConfigs The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio. See Custom File System Config below.
*
* @return builder
*
*/
public Builder customFileSystemConfigs(List customFileSystemConfigs) {
return customFileSystemConfigs(Output.of(customFileSystemConfigs));
}
/**
* @param customFileSystemConfigs The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio. See Custom File System Config below.
*
* @return builder
*
*/
public Builder customFileSystemConfigs(UserProfileUserSettingsCustomFileSystemConfigArgs... customFileSystemConfigs) {
return customFileSystemConfigs(List.of(customFileSystemConfigs));
}
/**
* @param customPosixUserConfig Details about the POSIX identity that is used for file system operations. See Custom Posix User Config below.
*
* @return builder
*
*/
public Builder customPosixUserConfig(@Nullable Output customPosixUserConfig) {
$.customPosixUserConfig = customPosixUserConfig;
return this;
}
/**
* @param customPosixUserConfig Details about the POSIX identity that is used for file system operations. See Custom Posix User Config below.
*
* @return builder
*
*/
public Builder customPosixUserConfig(UserProfileUserSettingsCustomPosixUserConfigArgs customPosixUserConfig) {
return customPosixUserConfig(Output.of(customPosixUserConfig));
}
/**
* @param defaultLandingUri 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 if StudioWebPortal is set to ENABLED. `app:JupyterServer:`: Indicates that Studio Classic is the default experience.
*
* @return builder
*
*/
public Builder defaultLandingUri(@Nullable Output defaultLandingUri) {
$.defaultLandingUri = defaultLandingUri;
return this;
}
/**
* @param defaultLandingUri 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 if StudioWebPortal is set to ENABLED. `app:JupyterServer:`: Indicates that Studio Classic is the default experience.
*
* @return builder
*
*/
public Builder defaultLandingUri(String defaultLandingUri) {
return defaultLandingUri(Output.of(defaultLandingUri));
}
/**
* @param executionRole The execution role ARN for the user.
*
* @return builder
*
*/
public Builder executionRole(Output executionRole) {
$.executionRole = executionRole;
return this;
}
/**
* @param executionRole The execution role ARN for the user.
*
* @return builder
*
*/
public Builder executionRole(String executionRole) {
return executionRole(Output.of(executionRole));
}
/**
* @param jupyterLabAppSettings The settings for the JupyterLab application. See Jupyter Lab App Settings below.
*
* @return builder
*
*/
public Builder jupyterLabAppSettings(@Nullable Output jupyterLabAppSettings) {
$.jupyterLabAppSettings = jupyterLabAppSettings;
return this;
}
/**
* @param jupyterLabAppSettings The settings for the JupyterLab application. See Jupyter Lab App Settings below.
*
* @return builder
*
*/
public Builder jupyterLabAppSettings(UserProfileUserSettingsJupyterLabAppSettingsArgs jupyterLabAppSettings) {
return jupyterLabAppSettings(Output.of(jupyterLabAppSettings));
}
/**
* @param jupyterServerAppSettings The Jupyter server's app settings. See Jupyter Server App Settings below.
*
* @return builder
*
*/
public Builder jupyterServerAppSettings(@Nullable Output jupyterServerAppSettings) {
$.jupyterServerAppSettings = jupyterServerAppSettings;
return this;
}
/**
* @param jupyterServerAppSettings The Jupyter server's app settings. See Jupyter Server App Settings below.
*
* @return builder
*
*/
public Builder jupyterServerAppSettings(UserProfileUserSettingsJupyterServerAppSettingsArgs jupyterServerAppSettings) {
return jupyterServerAppSettings(Output.of(jupyterServerAppSettings));
}
/**
* @param kernelGatewayAppSettings The kernel gateway app settings. See Kernel Gateway App Settings below.
*
* @return builder
*
*/
public Builder kernelGatewayAppSettings(@Nullable Output kernelGatewayAppSettings) {
$.kernelGatewayAppSettings = kernelGatewayAppSettings;
return this;
}
/**
* @param kernelGatewayAppSettings The kernel gateway app settings. See Kernel Gateway App Settings below.
*
* @return builder
*
*/
public Builder kernelGatewayAppSettings(UserProfileUserSettingsKernelGatewayAppSettingsArgs kernelGatewayAppSettings) {
return kernelGatewayAppSettings(Output.of(kernelGatewayAppSettings));
}
/**
* @param rSessionAppSettings The RSession app settings. See RSession App Settings below.
*
* @return builder
*
*/
public Builder rSessionAppSettings(@Nullable Output rSessionAppSettings) {
$.rSessionAppSettings = rSessionAppSettings;
return this;
}
/**
* @param rSessionAppSettings The RSession app settings. See RSession App Settings below.
*
* @return builder
*
*/
public Builder rSessionAppSettings(UserProfileUserSettingsRSessionAppSettingsArgs rSessionAppSettings) {
return rSessionAppSettings(Output.of(rSessionAppSettings));
}
/**
* @param rStudioServerProAppSettings A collection of settings that configure user interaction with the RStudioServerPro app. See RStudioServerProAppSettings below.
*
* @return builder
*
*/
public Builder rStudioServerProAppSettings(@Nullable Output rStudioServerProAppSettings) {
$.rStudioServerProAppSettings = rStudioServerProAppSettings;
return this;
}
/**
* @param rStudioServerProAppSettings A collection of settings that configure user interaction with the RStudioServerPro app. See RStudioServerProAppSettings below.
*
* @return builder
*
*/
public Builder rStudioServerProAppSettings(UserProfileUserSettingsRStudioServerProAppSettingsArgs rStudioServerProAppSettings) {
return rStudioServerProAppSettings(Output.of(rStudioServerProAppSettings));
}
/**
* @param securityGroups A list of security group IDs that will be attached to the user.
*
* @return builder
*
*/
public Builder securityGroups(@Nullable Output> securityGroups) {
$.securityGroups = securityGroups;
return this;
}
/**
* @param securityGroups A list of security group IDs that will be attached to the user.
*
* @return builder
*
*/
public Builder securityGroups(List securityGroups) {
return securityGroups(Output.of(securityGroups));
}
/**
* @param securityGroups A list of security group IDs that will be attached to the user.
*
* @return builder
*
*/
public Builder securityGroups(String... securityGroups) {
return securityGroups(List.of(securityGroups));
}
/**
* @param sharingSettings The sharing settings. See Sharing Settings below.
*
* @return builder
*
*/
public Builder sharingSettings(@Nullable Output sharingSettings) {
$.sharingSettings = sharingSettings;
return this;
}
/**
* @param sharingSettings The sharing settings. See Sharing Settings below.
*
* @return builder
*
*/
public Builder sharingSettings(UserProfileUserSettingsSharingSettingsArgs sharingSettings) {
return sharingSettings(Output.of(sharingSettings));
}
/**
* @param spaceStorageSettings The storage settings for a private space. See Space Storage Settings below.
*
* @return builder
*
*/
public Builder spaceStorageSettings(@Nullable Output spaceStorageSettings) {
$.spaceStorageSettings = spaceStorageSettings;
return this;
}
/**
* @param spaceStorageSettings The storage settings for a private space. See Space Storage Settings below.
*
* @return builder
*
*/
public Builder spaceStorageSettings(UserProfileUserSettingsSpaceStorageSettingsArgs spaceStorageSettings) {
return spaceStorageSettings(Output.of(spaceStorageSettings));
}
/**
* @param studioWebPortal 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. Valid values are `ENABLED` and `DISABLED`.
*
* @return builder
*
*/
public Builder studioWebPortal(@Nullable Output studioWebPortal) {
$.studioWebPortal = studioWebPortal;
return this;
}
/**
* @param studioWebPortal 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. Valid values are `ENABLED` and `DISABLED`.
*
* @return builder
*
*/
public Builder studioWebPortal(String studioWebPortal) {
return studioWebPortal(Output.of(studioWebPortal));
}
/**
* @param studioWebPortalSettings The Studio Web Portal settings. See `studio_web_portal_settings` Block below.
*
* @return builder
*
*/
public Builder studioWebPortalSettings(@Nullable Output studioWebPortalSettings) {
$.studioWebPortalSettings = studioWebPortalSettings;
return this;
}
/**
* @param studioWebPortalSettings The Studio Web Portal settings. See `studio_web_portal_settings` Block below.
*
* @return builder
*
*/
public Builder studioWebPortalSettings(UserProfileUserSettingsStudioWebPortalSettingsArgs studioWebPortalSettings) {
return studioWebPortalSettings(Output.of(studioWebPortalSettings));
}
/**
* @param tensorBoardAppSettings The TensorBoard app settings. See TensorBoard App Settings below.
*
* @return builder
*
*/
public Builder tensorBoardAppSettings(@Nullable Output tensorBoardAppSettings) {
$.tensorBoardAppSettings = tensorBoardAppSettings;
return this;
}
/**
* @param tensorBoardAppSettings The TensorBoard app settings. See TensorBoard App Settings below.
*
* @return builder
*
*/
public Builder tensorBoardAppSettings(UserProfileUserSettingsTensorBoardAppSettingsArgs tensorBoardAppSettings) {
return tensorBoardAppSettings(Output.of(tensorBoardAppSettings));
}
public UserProfileUserSettingsArgs build() {
if ($.executionRole == null) {
throw new MissingRequiredPropertyException("UserProfileUserSettingsArgs", "executionRole");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy