class Aws::SageMaker::Types::CreateUserProfileRequest

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

data as a hash:

    {
      domain_id: "DomainId", # required
      user_profile_name: "UserProfileName", # required
      single_sign_on_user_identifier: "SingleSignOnUserIdentifier",
      single_sign_on_user_value: "String256",
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
      user_settings: {
        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] domain_id

The ID of the associated Domain.
@return [String]

@!attribute [rw] user_profile_name

A name for the UserProfile. This value is not case sensitive.
@return [String]

@!attribute [rw] single_sign_on_user_identifier

A specifier for the type of value specified in
SingleSignOnUserValue. Currently, the only supported value is
"UserName". If the Domain's AuthMode is SSO, this field is
required. If the Domain's AuthMode is not SSO, this field cannot be
specified.
@return [String]

@!attribute [rw] single_sign_on_user_value

The username of the associated Amazon Web Services Single Sign-On
User for this UserProfile. If the Domain's AuthMode is SSO, this
field is required, and must match a valid username of a user in your
directory. If the Domain's AuthMode is not SSO, this field cannot
be specified.
@return [String]

@!attribute [rw] tags

Each tag consists of a key and an optional value. Tag keys must be
unique per resource.

Tags that you specify for the User Profile are also added to all
Apps that the User Profile launches.
@return [Array<Types::Tag>]

@!attribute [rw] user_settings

A collection of settings.
@return [Types::UserSettings]

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

Constants

SENSITIVE