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

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

Properties

AuthMode string | Aws_CF_FunctionString required

The mode of authentication that members use to access the domain.

DefaultUserSettings object required

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.

7 nested properties
ExecutionRole string | Aws_CF_FunctionString required

The execution role for the user.

JupyterServerAppSettings object

The JupyterServer app settings.

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

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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.

RSessionAppSettings object

A collection of settings that apply to an RSessionGateway app.

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
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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.

DomainName string | Aws_CF_FunctionString required

A name for the domain.

SubnetIds string[] required

The VPC subnets that Studio uses for communication.

minItems=1maxItems=16
VpcId string | Aws_CF_FunctionString required

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

AppNetworkAccessType string | Aws_CF_FunctionString

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

DefaultSpaceSettings object

A collection of settings that apply to spaces of Amazon SageMaker Studio. These settings are specified when the Create/Update Domain API is called.

4 nested properties
ExecutionRole string | Aws_CF_FunctionString required

The execution role for the space.

JupyterServerAppSettings object

The JupyterServer app settings.

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

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

SecurityGroups string[]

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

minItems=0maxItems=5
KmsKeyId string | Aws_CF_FunctionString

SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default.

Tags Tag[]

A list of tags to apply to the user profile.

minItems=0maxItems=50
DomainSettings object

A collection of Domain settings.

2 nested properties
SecurityGroupIds string[]

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

minItems=1maxItems=3
RStudioServerProDomainSettings object

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

4 nested properties
DomainExecutionRoleArn string | Aws_CF_FunctionString required

The ARN of the execution role for the RStudioServerPro Domain-level app.

RStudioConnectUrl string | Aws_CF_FunctionString

A URL pointing to an RStudio Connect server.

RStudioPackageManagerUrl string | Aws_CF_FunctionString

A URL pointing to an RStudio Package Manager server.

DefaultResourceSpec object
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

AppSecurityGroupManagement string | Aws_CF_FunctionString

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

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 required

The execution role for the user.

JupyterServerAppSettings object

The JupyterServer app settings.

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

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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.

RSessionAppSettings object

A collection of settings that apply to an RSessionGateway app.

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
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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.

DefaultSpaceSettings object

A collection of settings that apply to spaces of Amazon SageMaker Studio. These settings are specified when the Create/Update Domain API is called.

ExecutionRole string | Aws_CF_FunctionString required

The execution role for the space.

JupyterServerAppSettings object

The JupyterServer app settings.

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

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

SecurityGroups string[]

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

minItems=0maxItems=5
JupyterServerAppSettings object

The JupyterServer app settings.

DefaultResourceSpec object
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

ResourceSpec object
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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
DomainSettings object

A collection of Domain settings.

SecurityGroupIds string[]

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

minItems=1maxItems=3
RStudioServerProDomainSettings object

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

4 nested properties
DomainExecutionRoleArn string | Aws_CF_FunctionString required

The ARN of the execution role for the RStudioServerPro Domain-level app.

RStudioConnectUrl string | Aws_CF_FunctionString

A URL pointing to an RStudio Connect server.

RStudioPackageManagerUrl string | Aws_CF_FunctionString

A URL pointing to an RStudio Package Manager server.

DefaultResourceSpec object
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

RStudioServerProDomainSettings object

A collection of settings that update the current configuration for the RStudioServerPro Domain-level app.

DomainExecutionRoleArn string | Aws_CF_FunctionString required

The ARN of the execution role for the RStudioServerPro Domain-level app.

RStudioConnectUrl string | Aws_CF_FunctionString

A URL pointing to an RStudio Connect server.

RStudioPackageManagerUrl string | Aws_CF_FunctionString

A URL pointing to an RStudio Package Manager server.

DefaultResourceSpec object
4 nested properties
InstanceType string | Aws_CF_FunctionString

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

RSessionAppSettings object

A collection of settings that apply to an RSessionGateway app.

CustomImages CustomImage[]

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

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

The instance type that the image version runs on.

SageMakerImageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the image version created on the instance.

LifecycleConfigArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.

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.