Skip to contents

Creates a Domain

Source: R/sagemaker_operations.R
sagemaker_create_domain.Rd

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.

See https://www.paws-r-sdk.com/docs/sagemaker_create_domain/ for full documentation.

Usage

sagemaker_create_domain(
  DomainName,
  AuthMode,
  DefaultUserSettings,
  DomainSettings = NULL,
  SubnetIds = NULL,
  VpcId = NULL,
  Tags = NULL,
  AppNetworkAccessType = NULL,
  HomeEfsFileSystemKmsKeyId = NULL,
  KmsKeyId = NULL,
  AppSecurityGroupManagement = NULL,
  HomeEfsFileSystemCreation = NULL,
  TagPropagation = NULL,
  DefaultSpaceSettings = NULL
)

Arguments

DomainName

[required] A name for the domain.

AuthMode

[required] The mode of authentication that members use to access the domain.

DefaultUserSettings

[required] The default settings to use to create a user profile when UserSettings isn't specified in the call to the create_user_profile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in create_user_profile take precedence over those specified in create_domain.

DomainSettings

A collection of Domain settings.

SubnetIds

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.

VpcId

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.

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 search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

AppNetworkAccessType

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

HomeEfsFileSystemKmsKeyId

Use KmsKeyId.

KmsKeyId

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.

AppSecurityGroupManagement

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.

HomeEfsFileSystemCreation

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 update_domain.

TagPropagation

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

DefaultSpaceSettings

The default settings for shared spaces that users create in the domain.