AWS::SageMaker::Domain

SageMaker Domain

Resource Type definition for AWS::SageMaker::Domain

Properties

12 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`AuthMode`	`string`	RequiredCreate-only
`DefaultUserSettings`	`UserSettings`	Required
`DomainName`	`string`	RequiredCreate-only
`AppNetworkAccessType`	`string`
`AppSecurityGroupManagement`	`string`
`DefaultSpaceSettings`	`DefaultSpaceSettings`
`DomainSettings`	`DomainSettings`
`KmsKeyId`	`string`	Create-only
`SubnetIds`	`Array<string>`
`TagPropagation`	`string`
`Tags`	`Array<Tag>`	Create-onlyWrite-only
`VpcId`	`string`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`DomainArn`	`string`	The Amazon Resource Name (ARN) of the created domain.
`DomainId`	`string`	The domain name.
`HomeEfsFileSystemId`	`string`	The ID of the Amazon Elastic File System (EFS) managed by this Domain.
`SecurityGroupIdForDomainBoundary`	`string`	The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
`SingleSignOnApplicationArn`	`string`	The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
`SingleSignOnManagedApplicationInstanceId`	`string`	The SSO managed application instance ID.
`Url`	`string`	The URL to the created domain.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::SageMaker::Domain

Resources:
  MyResource:
    Type: AWS::SageMaker::Domain
    Properties:
      AuthMode: "SSO"
      DefaultUserSettings: "value"
      DomainName: "my-domainname"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

sagemaker:CreateAppsagemaker:CreateDomainsagemaker:DescribeDomainsagemaker:DescribeImagesagemaker:DescribeImageVersioniam:CreateServiceLinkedRoleiam:PassRoleefs:CreateFileSystem

read

sagemaker:DescribeDomain

update

sagemaker:CreateAppsagemaker:UpdateDomainsagemaker:DescribeDomainsagemaker:DescribeImagesagemaker:DescribeImageVersioniam:PassRole

delete

sagemaker:DeleteAppsagemaker:DeleteDomainsagemaker:DescribeDomain

list

sagemaker:ListDomains

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceSageMaker

Properties19

Required3

TaggingNot supported

Primary IDDomainId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AuthModeDomainNameDomainSettings/RStudioServerProDomainSettings/DefaultResourceSpecKmsKeyIdTags

Related Resources

External Links

AWS Documentation