domains

Creates, updates, deletes, gets or lists a domains resource.

Overview

Name	domains
Type	Resource
Id	aws.sagemaker.domains

Fields

The following fields are returned by SELECT queries:

describe_domain

Name	Datatype	Description
app_network_access_type	string	Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access VpcOnly - All traffic is through the specified VPC and subnets (PublicInternetOnly, VpcOnly)
app_security_group_management	string	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. (Service, Customer)
auth_mode	string	The domain's authentication mode. (SSO, IAM)
creation_time	string (date-time)	The creation time.
default_space_settings	object	The default settings for shared spaces that users create in the domain.
default_user_settings	object	Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
domain_arn	string	The domain's Amazon Resource Name (ARN). (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:domain/.*</code>)
domain_id	string	The domain ID. (pattern: <code>d-(-*[a-z0-9]){1,61}</code>)
domain_name	string	The domain name. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
domain_settings	object	A collection of Domain settings.
failure_reason	string	The failure reason.
home_efs_file_system_creation	string	Indicates whether a home EFS file system is created for the domain. (Enabled, Disabled)
home_efs_file_system_id	string	The ID of the Amazon Elastic File System managed by this Domain.
home_efs_file_system_kms_key_id	string	Use KmsKeyId. (pattern: <code>[a-zA-Z0-9:/_-]*</code>)
kms_key_id	string	The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain. (pattern: <code>[a-zA-Z0-9:/_-]*</code>)
last_modified_time	string (date-time)	The last modified time.
security_group_id_for_domain_boundary	string	The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app. (pattern: <code>[-0-9a-zA-Z]+</code>)
single_sign_on_application_arn	string	The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after October 1, 2023. (pattern: <code>arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application/[a-zA-Z0-9-_.]+/apl-[a-zA-Z0-9]+</code>)
single_sign_on_managed_application_instance_id	string	The IAM Identity Center managed application instance ID.
status	string	The status. (Deleting, Failed, InService, Pending, Updating, Update_Failed, Delete_Failed)
subnet_ids	array	The VPC subnets that the domain uses for communication.
tag_propagation	string	Indicates whether custom tag propagation is supported for the domain. (ENABLED, DISABLED)
url	string	The domain's URL.
vpc_id	string	The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication. (pattern: <code>[-0-9a-zA-Z]+</code>)

list_domains

Name	Datatype	Description
creation_time	string (date-time)	The creation time.
domain_arn	string	The domain's Amazon Resource Name (ARN). (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:domain/.*</code>)
domain_id	string	The domain ID. (pattern: <code>d-(-*[a-z0-9]){1,61}</code>)
domain_name	string	The domain name. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)
last_modified_time	string (date-time)	The last modified time.
status	string	The status. (Deleting, Failed, InService, Pending, Updating, Update_Failed, Delete_Failed)
url	string	The domain's URL.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_domain	select	region		The description of the domain.
list_domains	select	region		Lists the domains.
create_domain	insert	region, DomainName, AuthMode, DefaultUserSettings		Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other. EFS storage When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files. SageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption. VPC configuration All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available: PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value. VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. When internet access is disabled, you won't be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections. NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully. For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.
update_domain	update	region, DomainId		Updates the default settings for new user profiles in the domain.
delete_domain	delete	region		Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_domain

The description of the domain.

SELECT
app_network_access_type,
app_security_group_management,
auth_mode,
creation_time,
default_space_settings,
default_user_settings,
domain_arn,
domain_id,
domain_name,
domain_settings,
failure_reason,
home_efs_file_system_creation,
home_efs_file_system_id,
home_efs_file_system_kms_key_id,
kms_key_id,
last_modified_time,
security_group_id_for_domain_boundary,
single_sign_on_application_arn,
single_sign_on_managed_application_instance_id,
status,
subnet_ids,
tag_propagation,
url,
vpc_id
FROM aws.sagemaker.domains
WHERE region = '{{ region }}' -- required
;

list_domains

Lists the domains.

SELECT
creation_time,
domain_arn,
domain_id,
domain_name,
last_modified_time,
status,
url
FROM aws.sagemaker.domains
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_domain

Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other. EFS storage When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files. SageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption. VPC configuration All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available: PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value. VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. When internet access is disabled, you won't be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections. NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully. For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.

INSERT INTO aws.sagemaker.domains (
DomainName,
AuthMode,
DefaultUserSettings,
DomainSettings,
SubnetIds,
VpcId,
Tags,
AppNetworkAccessType,
HomeEfsFileSystemKmsKeyId,
KmsKeyId,
AppSecurityGroupManagement,
HomeEfsFileSystemCreation,
TagPropagation,
DefaultSpaceSettings,
region
)
SELECT 
'{{ DomainName }}' /* required */,
'{{ AuthMode }}' /* required */,
'{{ DefaultUserSettings }}' /* required */,
'{{ DomainSettings }}',
'{{ SubnetIds }}',
'{{ VpcId }}',
'{{ Tags }}',
'{{ AppNetworkAccessType }}',
'{{ HomeEfsFileSystemKmsKeyId }}',
'{{ KmsKeyId }}',
'{{ AppSecurityGroupManagement }}',
'{{ HomeEfsFileSystemCreation }}',
'{{ TagPropagation }}',
'{{ DefaultSpaceSettings }}',
'{{ region }}'
RETURNING
domain_arn,
domain_id,
url
;

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the domains resource.
  - name: DomainName
    value: "{{ DomainName }}"
    description: |
      A name for the domain.
  - name: AuthMode
    value: "{{ AuthMode }}"
    description: |
      The mode of authentication that members use to access the domain.
    valid_values: ['SSO', 'IAM']
  - name: DefaultUserSettings
    description: |
      The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API. 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.
    value:
      ExecutionRole: "{{ ExecutionRole }}"
      SecurityGroups:
        - "{{ SecurityGroups }}"
      SharingSettings:
        NotebookOutputOption: "{{ NotebookOutputOption }}"
        S3OutputPath: "{{ S3OutputPath }}"
        S3KmsKeyId: "{{ S3KmsKeyId }}"
      JupyterServerAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        LifecycleConfigArns:
          - "{{ LifecycleConfigArns }}"
        CodeRepositories:
          - RepositoryUrl: "{{ RepositoryUrl }}"
      KernelGatewayAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        CustomImages:
          - ImageName: "{{ ImageName }}"
            ImageVersionNumber: {{ ImageVersionNumber }}
            AppImageConfigName: "{{ AppImageConfigName }}"
        LifecycleConfigArns:
          - "{{ LifecycleConfigArns }}"
      TensorBoardAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
      RStudioServerProAppSettings:
        AccessStatus: "{{ AccessStatus }}"
        UserGroup: "{{ UserGroup }}"
      RSessionAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        CustomImages:
          - ImageName: "{{ ImageName }}"
            ImageVersionNumber: {{ ImageVersionNumber }}
            AppImageConfigName: "{{ AppImageConfigName }}"
      CanvasAppSettings:
        TimeSeriesForecastingSettings:
          Status: "{{ Status }}"
          AmazonForecastRoleArn: "{{ AmazonForecastRoleArn }}"
        ModelRegisterSettings:
          Status: "{{ Status }}"
          CrossAccountModelRegisterRoleArn: "{{ CrossAccountModelRegisterRoleArn }}"
        WorkspaceSettings:
          S3ArtifactPath: "{{ S3ArtifactPath }}"
          S3KmsKeyId: "{{ S3KmsKeyId }}"
        IdentityProviderOAuthSettings:
          - DataSourceName: "{{ DataSourceName }}"
            Status: "{{ Status }}"
            SecretArn: "{{ SecretArn }}"
        DirectDeploySettings:
          Status: "{{ Status }}"
        KendraSettings:
          Status: "{{ Status }}"
        GenerativeAiSettings:
          AmazonBedrockRoleArn: "{{ AmazonBedrockRoleArn }}"
        EmrServerlessSettings:
          ExecutionRoleArn: "{{ ExecutionRoleArn }}"
          Status: "{{ Status }}"
      CodeEditorAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        CustomImages:
          - ImageName: "{{ ImageName }}"
            ImageVersionNumber: {{ ImageVersionNumber }}
            AppImageConfigName: "{{ AppImageConfigName }}"
        LifecycleConfigArns:
          - "{{ LifecycleConfigArns }}"
        AppLifecycleManagement:
          IdleSettings:
            LifecycleManagement: "{{ LifecycleManagement }}"
            IdleTimeoutInMinutes: {{ IdleTimeoutInMinutes }}
            MinIdleTimeoutInMinutes: {{ MinIdleTimeoutInMinutes }}
            MaxIdleTimeoutInMinutes: {{ MaxIdleTimeoutInMinutes }}
        BuiltInLifecycleConfigArn: "{{ BuiltInLifecycleConfigArn }}"
      JupyterLabAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        CustomImages:
          - ImageName: "{{ ImageName }}"
            ImageVersionNumber: {{ ImageVersionNumber }}
            AppImageConfigName: "{{ AppImageConfigName }}"
        LifecycleConfigArns:
          - "{{ LifecycleConfigArns }}"
        CodeRepositories:
          - RepositoryUrl: "{{ RepositoryUrl }}"
        AppLifecycleManagement:
          IdleSettings:
            LifecycleManagement: "{{ LifecycleManagement }}"
            IdleTimeoutInMinutes: {{ IdleTimeoutInMinutes }}
            MinIdleTimeoutInMinutes: {{ MinIdleTimeoutInMinutes }}
            MaxIdleTimeoutInMinutes: {{ MaxIdleTimeoutInMinutes }}
        EmrSettings:
          AssumableRoleArns:
            - "{{ AssumableRoleArns }}"
          ExecutionRoleArns:
            - "{{ ExecutionRoleArns }}"
        BuiltInLifecycleConfigArn: "{{ BuiltInLifecycleConfigArn }}"
      SpaceStorageSettings:
        DefaultEbsStorageSettings:
          DefaultEbsVolumeSizeInGb: {{ DefaultEbsVolumeSizeInGb }}
          MaximumEbsVolumeSizeInGb: {{ MaximumEbsVolumeSizeInGb }}
      DefaultLandingUri: "{{ DefaultLandingUri }}"
      StudioWebPortal: "{{ StudioWebPortal }}"
      CustomPosixUserConfig:
        Uid: {{ Uid }}
        Gid: {{ Gid }}
      CustomFileSystemConfigs:
        - EFSFileSystemConfig:
            FileSystemId: "{{ FileSystemId }}"
            FileSystemPath: "{{ FileSystemPath }}"
          FSxLustreFileSystemConfig:
            FileSystemId: "{{ FileSystemId }}"
            FileSystemPath: "{{ FileSystemPath }}"
          S3FileSystemConfig:
            MountPath: "{{ MountPath }}"
            S3Uri: "{{ S3Uri }}"
      StudioWebPortalSettings:
        HiddenMlTools:
          - "{{ HiddenMlTools }}"
        HiddenAppTypes:
          - "{{ HiddenAppTypes }}"
        HiddenInstanceTypes:
          - "{{ HiddenInstanceTypes }}"
        HiddenSageMakerImageVersionAliases:
          - SageMakerImageName: "{{ SageMakerImageName }}"
            VersionAliases: "{{ VersionAliases }}"
        ExecutionRoleSessionNameMode: "{{ ExecutionRoleSessionNameMode }}"
      AutoMountHomeEFS: "{{ AutoMountHomeEFS }}"
  - name: DomainSettings
    description: |
      A collection of Domain settings.
    value:
      SecurityGroupIds:
        - "{{ SecurityGroupIds }}"
      RStudioServerProDomainSettings:
        DomainExecutionRoleArn: "{{ DomainExecutionRoleArn }}"
        RStudioConnectUrl: "{{ RStudioConnectUrl }}"
        RStudioPackageManagerUrl: "{{ RStudioPackageManagerUrl }}"
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
      ExecutionRoleIdentityConfig: "{{ ExecutionRoleIdentityConfig }}"
      TrustedIdentityPropagationSettings:
        Status: "{{ Status }}"
      DockerSettings:
        EnableDockerAccess: "{{ EnableDockerAccess }}"
        VpcOnlyTrustedAccounts:
          - "{{ VpcOnlyTrustedAccounts }}"
        RootlessDocker: "{{ RootlessDocker }}"
      AmazonQSettings:
        Status: "{{ Status }}"
        QProfileArn: "{{ QProfileArn }}"
      UnifiedStudioSettings:
        StudioWebPortalAccess: "{{ StudioWebPortalAccess }}"
        DomainAccountId: "{{ DomainAccountId }}"
        DomainRegion: "{{ DomainRegion }}"
        DomainId: "{{ DomainId }}"
        ProjectId: "{{ ProjectId }}"
        EnvironmentId: "{{ EnvironmentId }}"
        ProjectS3Path: "{{ ProjectS3Path }}"
        SingleSignOnApplicationArn: "{{ SingleSignOnApplicationArn }}"
      IpAddressType: "{{ IpAddressType }}"
  - name: SubnetIds
    value:
      - "{{ SubnetIds }}"
    description: |
      The VPC subnets that the domain uses for communication. The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.
  - name: VpcId
    value: "{{ VpcId }}"
    description: |
      The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication. The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.
  - name: Tags
    description: |
      Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API. Tags that you specify for the Domain are also added to all Apps that the Domain launches.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: AppNetworkAccessType
    value: "{{ AppNetworkAccessType }}"
    description: |
      Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access VpcOnly - All traffic is through the specified VPC and subnets
    valid_values: ['PublicInternetOnly', 'VpcOnly']
  - name: HomeEfsFileSystemKmsKeyId
    value: "{{ HomeEfsFileSystemKmsKeyId }}"
    description: |
      Use KmsKeyId.
  - name: KmsKeyId
    value: "{{ KmsKeyId }}"
    description: |
      SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.
  - name: AppSecurityGroupManagement
    value: "{{ AppSecurityGroupManagement }}"
    description: |
      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. If setting up the domain for use with RStudio, this value must be set to Service.
    valid_values: ['Service', 'Customer']
  - name: HomeEfsFileSystemCreation
    value: "{{ HomeEfsFileSystemCreation }}"
    description: |
      Indicates whether to create a home EFS file system for the domain. Defaults to Enabled. Set to Disabled to skip EFS creation and reduce domain creation time. You can enable EFS later by calling UpdateDomain.
    valid_values: ['Enabled', 'Disabled']
  - name: TagPropagation
    value: "{{ TagPropagation }}"
    description: |
      Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.
    valid_values: ['ENABLED', 'DISABLED']
  - name: DefaultSpaceSettings
    description: |
      The default settings for shared spaces that users create in the domain.
    value:
      ExecutionRole: "{{ ExecutionRole }}"
      SecurityGroups:
        - "{{ SecurityGroups }}"
      JupyterServerAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        LifecycleConfigArns:
          - "{{ LifecycleConfigArns }}"
        CodeRepositories:
          - RepositoryUrl: "{{ RepositoryUrl }}"
      KernelGatewayAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        CustomImages:
          - ImageName: "{{ ImageName }}"
            ImageVersionNumber: {{ ImageVersionNumber }}
            AppImageConfigName: "{{ AppImageConfigName }}"
        LifecycleConfigArns:
          - "{{ LifecycleConfigArns }}"
      JupyterLabAppSettings:
        DefaultResourceSpec:
          SageMakerImageArn: "{{ SageMakerImageArn }}"
          SageMakerImageVersionArn: "{{ SageMakerImageVersionArn }}"
          SageMakerImageVersionAlias: "{{ SageMakerImageVersionAlias }}"
          InstanceType: "{{ InstanceType }}"
          LifecycleConfigArn: "{{ LifecycleConfigArn }}"
          TrainingPlanArn: "{{ TrainingPlanArn }}"
        CustomImages:
          - ImageName: "{{ ImageName }}"
            ImageVersionNumber: {{ ImageVersionNumber }}
            AppImageConfigName: "{{ AppImageConfigName }}"
        LifecycleConfigArns:
          - "{{ LifecycleConfigArns }}"
        CodeRepositories:
          - RepositoryUrl: "{{ RepositoryUrl }}"
        AppLifecycleManagement:
          IdleSettings:
            LifecycleManagement: "{{ LifecycleManagement }}"
            IdleTimeoutInMinutes: {{ IdleTimeoutInMinutes }}
            MinIdleTimeoutInMinutes: {{ MinIdleTimeoutInMinutes }}
            MaxIdleTimeoutInMinutes: {{ MaxIdleTimeoutInMinutes }}
        EmrSettings:
          AssumableRoleArns:
            - "{{ AssumableRoleArns }}"
          ExecutionRoleArns:
            - "{{ ExecutionRoleArns }}"
        BuiltInLifecycleConfigArn: "{{ BuiltInLifecycleConfigArn }}"
      SpaceStorageSettings:
        DefaultEbsStorageSettings:
          DefaultEbsVolumeSizeInGb: {{ DefaultEbsVolumeSizeInGb }}
          MaximumEbsVolumeSizeInGb: {{ MaximumEbsVolumeSizeInGb }}
      CustomPosixUserConfig:
        Uid: {{ Uid }}
        Gid: {{ Gid }}
      CustomFileSystemConfigs:
        - EFSFileSystemConfig:
            FileSystemId: "{{ FileSystemId }}"
            FileSystemPath: "{{ FileSystemPath }}"
          FSxLustreFileSystemConfig:
            FileSystemId: "{{ FileSystemId }}"
            FileSystemPath: "{{ FileSystemPath }}"
          S3FileSystemConfig:
            MountPath: "{{ MountPath }}"
            S3Uri: "{{ S3Uri }}"

UPDATE examples

update_domain

Updates the default settings for new user profiles in the domain.

UPDATE aws.sagemaker.domains
SET 
DomainId = '{{ DomainId }}',
DefaultUserSettings = '{{ DefaultUserSettings }}',
DomainSettingsForUpdate = '{{ DomainSettingsForUpdate }}',
AppSecurityGroupManagement = '{{ AppSecurityGroupManagement }}',
DefaultSpaceSettings = '{{ DefaultSpaceSettings }}',
SubnetIds = '{{ SubnetIds }}',
AppNetworkAccessType = '{{ AppNetworkAccessType }}',
TagPropagation = '{{ TagPropagation }}',
HomeEfsFileSystemCreation = '{{ HomeEfsFileSystemCreation }}',
VpcId = '{{ VpcId }}'
WHERE 
region = '{{ region }}' --required
AND DomainId = '{{ DomainId }}' --required
RETURNING
domain_arn;

DELETE examples

delete_domain

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

DELETE FROM aws.sagemaker.domains
WHERE region = '{{ region }}' --required
;