L1 ConstructAWS::SageMaker::Domain

CfnDomain

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 AWS Key Management Service ( AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed key by default. For more control, you can specify a customer managed key. For more information, see [Protect Data at Rest Using Encryption](https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html) . *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](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html) .

Import

import { CfnDomain } from 'aws-cdk-lib/aws-sagemaker';

Or use the module namespace:

import * as sagemaker from 'aws-cdk-lib/aws-sagemaker';
// sagemaker.CfnDomain

Properties

Configuration passed to the constructor as CfnDomainProps.

authModeRequired

string

The mode of authentication that members use to access the Domain. *Valid Values* : `SSO | IAM`

defaultUserSettingsRequired

IResolvable | UserSettingsProperty

The default user settings.

domainNameRequired

string

The domain name.

appNetworkAccessTypeOptional

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 Studio traffic is through the specified VPC and subnets *Valid Values* : `PublicInternetOnly | VpcOnly`

appSecurityGroupManagementOptional

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. If setting up the domain for use with RStudio, this value must be set to `Service` . *Allowed Values* : `Service` | `Customer`

defaultSpaceSettingsOptional

IResolvable | DefaultSpaceSettingsProperty

The default settings for shared spaces that users create in the domain. SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.

domainSettingsOptional

IResolvable | DomainSettingsProperty

A collection of settings that apply to the `SageMaker Domain` . These settings are specified through the `CreateDomain` API call.

kmsKeyIdOptional

string

SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default. For more control, specify a customer managed CMK. *Length Constraints* : Maximum length of 2048. *Pattern* : `.*`

subnetIdsOptional

string | ISubnetRef[]

The VPC subnets that Studio uses for communication. *Length Constraints* : Maximum length of 32. *Array members* : Minimum number of 1 item. Maximum number of 16 items. *Pattern* : `[-0-9a-zA-Z]+`

tagPropagationOptional

string

Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.

tagsOptional

CfnTag[]

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 are launched in the Domain. *Array members* : Minimum number of 0 items. Maximum number of 50 items.

vpcIdOptional

string | IVPCRef

The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication. *Length Constraints* : Maximum length of 32. *Pattern* : `[-0-9a-zA-Z]+`

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::SageMaker::DomainView in CloudFormation Explorer

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

LevelL1 (CloudFormation)

Moduleaws-sagemaker

CFN TypeAWS::SageMaker::Domain

Properties12

Related Constructs

Explore This Service

External Links

CDK API Documentation