Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-sagemaker-userprofile.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::SageMaker::UserProfile. Source:- No source definition found, add manually please

Properties

DomainId string | Aws_CF_FunctionString required

The ID of the associated Domain.

UserProfileName string | Aws_CF_FunctionString required

A name for the UserProfile.

SingleSignOnUserIdentifier string | Aws_CF_FunctionString

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.

SingleSignOnUserValue string | Aws_CF_FunctionString

The username of the associated AWS 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.

UserSettings object

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.

6 nested properties
ExecutionRole string | Aws_CF_FunctionString

The user profile Amazon Resource Name (ARN).

JupyterServerAppSettings object

The JupyterServer app settings.

1 nested properties
DefaultResourceSpec object
3 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The ARN of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The ARN of the image version created on the instance.

KernelGatewayAppSettings object

The kernel gateway app settings.

2 nested properties
CustomImages CustomImage[]

A list of custom SageMaker images that are configured to run as a KernelGateway app.

minItems=0maxItems=30
DefaultResourceSpec object
3 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The ARN of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The ARN of the image version created on the instance.

RStudioServerProAppSettings object

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

2 nested properties
AccessStatus string | Aws_CF_FunctionString

Indicates whether the current user has access to the RStudioServerPro app.

UserGroup string | Aws_CF_FunctionString

The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

SecurityGroups string[]

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

minItems=0maxItems=5
SharingSettings object

Specifies options when sharing an Amazon SageMaker Studio notebook. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called.

3 nested properties
NotebookOutputOption string | Aws_CF_FunctionString

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

S3KmsKeyId string | Aws_CF_FunctionString

When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

S3OutputPath string | Aws_CF_FunctionString

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Tags Tag[]

A list of tags to apply to the user profile.

minItems=0maxItems=50

Definitions

UserSettings object

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.

ExecutionRole string | Aws_CF_FunctionString

The user profile Amazon Resource Name (ARN).

JupyterServerAppSettings object

The JupyterServer app settings.

1 nested properties
DefaultResourceSpec object
3 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The ARN of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The ARN of the image version created on the instance.

KernelGatewayAppSettings object

The kernel gateway app settings.

2 nested properties
CustomImages CustomImage[]

A list of custom SageMaker images that are configured to run as a KernelGateway app.

minItems=0maxItems=30
DefaultResourceSpec object
3 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The ARN of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The ARN of the image version created on the instance.

RStudioServerProAppSettings object

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

2 nested properties
AccessStatus string | Aws_CF_FunctionString

Indicates whether the current user has access to the RStudioServerPro app.

UserGroup string | Aws_CF_FunctionString

The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

SecurityGroups string[]

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

minItems=0maxItems=5
SharingSettings object

Specifies options when sharing an Amazon SageMaker Studio notebook. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called.

3 nested properties
NotebookOutputOption string | Aws_CF_FunctionString

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

S3KmsKeyId string | Aws_CF_FunctionString

When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

S3OutputPath string | Aws_CF_FunctionString

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

JupyterServerAppSettings object

The JupyterServer app settings.

DefaultResourceSpec object
3 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The ARN of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The ARN of the image version created on the instance.

ResourceSpec object
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The ARN of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The ARN of the image version created on the instance.

KernelGatewayAppSettings object

The kernel gateway app settings.

CustomImages CustomImage[]

A list of custom SageMaker images that are configured to run as a KernelGateway app.

minItems=0maxItems=30
DefaultResourceSpec object
3 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The ARN of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The ARN of the image version created on the instance.

CustomImage object

A custom SageMaker image.

AppImageConfigName string | Aws_CF_FunctionString required

The Name of the AppImageConfig.

ImageName string | Aws_CF_FunctionString required

The name of the CustomImage. Must be unique to your account.

ImageVersionNumber integer

The version number of the CustomImage.

min=0
SharingSettings object

Specifies options when sharing an Amazon SageMaker Studio notebook. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called.

NotebookOutputOption string | Aws_CF_FunctionString

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

S3KmsKeyId string | Aws_CF_FunctionString

When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

S3OutputPath string | Aws_CF_FunctionString

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Tag object
Value string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RStudioServerProAppSettings object

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

AccessStatus string | Aws_CF_FunctionString

Indicates whether the current user has access to the RStudioServerPro app.

UserGroup string | Aws_CF_FunctionString

The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.