Setting defaults for a domain - Amazon SageMaker
Domain default settingsContext keys
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Setting defaults for a domain

With SageMaker, you can set default settings for your resources at the Amazon SageMaker domain level. These default settings are used in the creation of resources within the domain. The following sections list default settings for domain and give information on using context keys when setting defaults.

Domain default settings

You can set the following defaults when creating or updating a domain. Values passed at the user profile and shared space level override defaults set at the domain level.

  • DefaultUserSettings

  • DefaultSpaceSettings

    Note

    DefaultSpaceSettings only supports the use of JupyterLab 3 image ARNs for SageMakerImageArn. For more information, see JupyterLab Versioning.

    "DefaultSpaceSettings": { 
      "ExecutionRole": "string",
      "JupyterServerAppSettings": { 
         "DefaultResourceSpec": { 
            "InstanceType": "string",
            "LifecycleConfigArn": "string",
            "SageMakerImageArn": "string",
            "SageMakerImageVersionArn": "string"
         },
         "LifecycleConfigArns": [ "string" ]
      },
      "KernelGatewayAppSettings": { 
         "CustomImages": [ 
            { 
               "AppImageConfigName": "string",
               "ImageName": "string",
               "ImageVersionNumber": number
            }
         ],
         "DefaultResourceSpec": { 
            "InstanceType": "string",
            "LifecycleConfigArn": "string",
            "SageMakerImageArn": "string",
            "SageMakerImageVersionArn": "string"
         },
         "LifecycleConfigArns": [ "string" ]
      },
      "SecurityGroups": [ "string" ]
   }

Context keys

You can add context keys to the IAM policy that creates a domain. This restricts the values that users can pass for those fields. The following list shows the context keys that domain supports and where they're implemented.

  • sagemaker:ImageArns

    • Implemented as part of DefaultUserSettings:SagemakerImageArn in DefaultUserSettings.JupyterServerAppSettings and DefaultUserSettings.KernelGatewayAppSettings. CustomImages in DefaultUserSettings.KernelGatewayAppSettings.

    • Implemented as part of DefaultSpaceSettings:SagemakerImageArn in DefaultSpaceSettings.JupyterServerAppSettings and DefaultSpaceSettings.KernelGatewayAppSettings. CustomImages in DefaultSpaceSettings.KernelGatewayAppSettings.

  • sagemaker:VpcSecurityGroupIds

    • Implemented as part of DefaultUserSettings:SecurityGroups in DefaultUserSettings.

    • Implemented as part of DefaultSpaceSettings:SecurityGroups in DefaultSpaceSettings.

  • sagemaker:DomainSharingOutputKmsKey

    Implemented as part of DefaultUserSettings:S3KmsKeyId in DefaultSpaceSettings.SharingSettings.

You cannot restrict users to passing incompatible values when using context keys for the defaults. For example, the values for SageMakerImageArn set as part of DefaultUserSettings and DefaultSpaceSettings must be compatible. You cannot set incompatible default values.