Creates a Domain used by Amazon SageMaker Studio
Creates a Domain used by Amazon SageMaker Studio. A domain consists of
an associated Amazon Elastic File System (EFS) volume, a list of
authorized users, and a variety of security, application, policy, and
Amazon Virtual Private Cloud (VPC) configurations. An AWS account is
limited to one domain per region. 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 AWS Key Management Service (AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default. For more control, you can specify a customer managed CMK. For more information, see Protect Data at Rest Using Encryption.
VPC configuration
All SageMaker Studio traffic between the domain and the EFS volume is
through the specified VPC and subnets. For other Studio traffic, you can
specify the AppNetworkAccessType parameter. AppNetworkAccessType
corresponds to the network access type that you choose when you onboard
to Studio. 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 Studio 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 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.
For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.
sagemaker_create_domain(DomainName, AuthMode, DefaultUserSettings, SubnetIds, VpcId, Tags, AppNetworkAccessType, HomeEfsFileSystemKmsKeyId, KmsKeyId)
DomainName |
[required] A name for the domain. |
AuthMode |
[required] The mode of authentication that members use to access the domain. |
DefaultUserSettings |
[required] The default user settings. |
SubnetIds |
[required] The VPC subnets that Studio uses for communication. |
VpcId |
[required] The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. |
Tags |
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 |
AppNetworkAccessType |
Specifies the VPC used for non-EFS traffic. The default value is
|
HomeEfsFileSystemKmsKeyId |
This member is deprecated and replaced with |
KmsKeyId |
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. |
A list with the following syntax:
list( DomainArn = "string", Url = "string" )
svc$create_domain(
DomainName = "string",
AuthMode = "SSO"|"IAM",
DefaultUserSettings = list(
ExecutionRole = "string",
SecurityGroups = list(
"string"
),
SharingSettings = list(
NotebookOutputOption = "Allowed"|"Disabled",
S3OutputPath = "string",
S3KmsKeyId = "string"
),
JupyterServerAppSettings = list(
DefaultResourceSpec = list(
SageMakerImageArn = "string",
SageMakerImageVersionArn = "string",
InstanceType = "system"|"ml.t3.micro"|"ml.t3.small"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.8xlarge"|"ml.m5.12xlarge"|"ml.m5.16xlarge"|"ml.m5.24xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.12xlarge"|"ml.c5.18xlarge"|"ml.c5.24xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"
)
),
KernelGatewayAppSettings = list(
DefaultResourceSpec = list(
SageMakerImageArn = "string",
SageMakerImageVersionArn = "string",
InstanceType = "system"|"ml.t3.micro"|"ml.t3.small"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.8xlarge"|"ml.m5.12xlarge"|"ml.m5.16xlarge"|"ml.m5.24xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.12xlarge"|"ml.c5.18xlarge"|"ml.c5.24xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"
),
CustomImages = list(
list(
ImageName = "string",
ImageVersionNumber = 123,
AppImageConfigName = "string"
)
)
),
TensorBoardAppSettings = list(
DefaultResourceSpec = list(
SageMakerImageArn = "string",
SageMakerImageVersionArn = "string",
InstanceType = "system"|"ml.t3.micro"|"ml.t3.small"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.8xlarge"|"ml.m5.12xlarge"|"ml.m5.16xlarge"|"ml.m5.24xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.12xlarge"|"ml.c5.18xlarge"|"ml.c5.24xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"
)
)
),
SubnetIds = list(
"string"
),
VpcId = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
AppNetworkAccessType = "PublicInternetOnly"|"VpcOnly",
HomeEfsFileSystemKmsKeyId = "string",
KmsKeyId = "string"
)Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.