class Aws::SageMaker::Types::UserSettings

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`.

@note When making an API call, you may pass UserSettings

data as a hash:

    {
      execution_role: "RoleArn",
      security_groups: ["SecurityGroupId"],
      sharing_settings: {
        notebook_output_option: "Allowed", # accepts Allowed, Disabled
        s3_output_path: "S3Uri",
        s3_kms_key_id: "KmsKeyId",
      },
      jupyter_server_app_settings: {
        default_resource_spec: {
          sage_maker_image_arn: "ImageArn",
          sage_maker_image_version_arn: "ImageVersionArn",
          instance_type: "system", # accepts system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.8xlarge, ml.m5d.12xlarge, ml.m5d.16xlarge, ml.m5d.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge
          lifecycle_config_arn: "StudioLifecycleConfigArn",
        },
        lifecycle_config_arns: ["StudioLifecycleConfigArn"],
      },
      kernel_gateway_app_settings: {
        default_resource_spec: {
          sage_maker_image_arn: "ImageArn",
          sage_maker_image_version_arn: "ImageVersionArn",
          instance_type: "system", # accepts system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.8xlarge, ml.m5d.12xlarge, ml.m5d.16xlarge, ml.m5d.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge
          lifecycle_config_arn: "StudioLifecycleConfigArn",
        },
        custom_images: [
          {
            image_name: "ImageName", # required
            image_version_number: 1,
            app_image_config_name: "AppImageConfigName", # required
          },
        ],
        lifecycle_config_arns: ["StudioLifecycleConfigArn"],
      },
      tensor_board_app_settings: {
        default_resource_spec: {
          sage_maker_image_arn: "ImageArn",
          sage_maker_image_version_arn: "ImageVersionArn",
          instance_type: "system", # accepts system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.8xlarge, ml.m5d.12xlarge, ml.m5d.16xlarge, ml.m5d.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge
          lifecycle_config_arn: "StudioLifecycleConfigArn",
        },
      },
    }

@!attribute [rw] execution_role

The execution role for the user.
@return [String]

@!attribute [rw] security_groups

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`.

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.
@return [Array<String>]

@!attribute [rw] sharing_settings

Specifies options for sharing SageMaker Studio notebooks.
@return [Types::SharingSettings]

@!attribute [rw] jupyter_server_app_settings

The Jupyter server's app settings.
@return [Types::JupyterServerAppSettings]

@!attribute [rw] kernel_gateway_app_settings

The kernel gateway app settings.
@return [Types::KernelGatewayAppSettings]

@!attribute [rw] tensor_board_app_settings

The TensorBoard app settings.
@return [Types::TensorBoardAppSettings]

@see docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UserSettings AWS API Documentation

Constants

SENSITIVE