/AWS1/CL_SGM=>CREATEDOMAIN()
¶
About CreateDomain¶
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 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, 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 Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker 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 Studio app successfully.
For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DOMAINNAME
TYPE /AWS1/SGMDOMAINNAME
/AWS1/SGMDOMAINNAME
¶
A name for the domain.
IV_AUTHMODE
TYPE /AWS1/SGMAUTHMODE
/AWS1/SGMAUTHMODE
¶
The mode of authentication that members use to access the domain.
IO_DEFAULTUSERSETTINGS
TYPE REF TO /AWS1/CL_SGMUSERSETTINGS
/AWS1/CL_SGMUSERSETTINGS
¶
The default settings to use to create a user profile when
UserSettings
isn't specified in the call to theCreateUserProfile
API.
SecurityGroups
is aggregated when specified in both calls. For all other settings inUserSettings
, the values specified inCreateUserProfile
take precedence over those specified inCreateDomain
.
IT_SUBNETIDS
TYPE /AWS1/CL_SGMSUBNETS_W=>TT_SUBNETS
TT_SUBNETS
¶
The VPC subnets that the domain uses for communication.
IV_VPCID
TYPE /AWS1/SGMVPCID
/AWS1/SGMVPCID
¶
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
Optional arguments:¶
IO_DOMAINSETTINGS
TYPE REF TO /AWS1/CL_SGMDOMAINSETTINGS
/AWS1/CL_SGMDOMAINSETTINGS
¶
A collection of
Domain
settings.
IT_TAGS
TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST
TT_TAGLIST
¶
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.
IV_APPNETWORKACCESSTYPE
TYPE /AWS1/SGMAPPNETWORKACCESSTYPE
/AWS1/SGMAPPNETWORKACCESSTYPE
¶
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, which allows direct internet access
VpcOnly
- All traffic is through the specified VPC and subnets
IV_HOMEEFSFILESYSTEMKMSKEYID
TYPE /AWS1/SGMKMSKEYID
/AWS1/SGMKMSKEYID
¶
Use
KmsKeyId
.
IV_KMSKEYID
TYPE /AWS1/SGMKMSKEYID
/AWS1/SGMKMSKEYID
¶
SageMaker 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.
IV_APPSECGROUPMANAGEMENT
TYPE /AWS1/SGMAPPSECGROUPMANAGEMENT
/AWS1/SGMAPPSECGROUPMANAGEMENT
¶
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required whenCreateDomain.AppNetworkAccessType
isVPCOnly
andDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided. If setting up the domain for use with RStudio, this value must be set toService
.
IO_DEFAULTSPACESETTINGS
TYPE REF TO /AWS1/CL_SGMDEFAULTSPACESTGS
/AWS1/CL_SGMDEFAULTSPACESTGS
¶
The default settings used to create a space.