CreateDomainRequest Class | AWS SDK for .NET V3

Container for the parameters to the CreateDomain operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.CreateDomainRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

public class CreateDomainRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The CreateDomainRequest type exposes the following members

Constructors

	Name	Description
	CreateDomainRequest()

Properties

Name	Type	Description
AppNetworkAccessType	Amazon.SageMaker.AppNetworkAccessType	Gets and sets the property 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, which allows direct internet access `VpcOnly` - All traffic is through the specified VPC and subnets
AppSecurityGroupManagement	Amazon.SageMaker.AppSecurityGroupManagement	Gets and sets the property 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`.
AuthMode	Amazon.SageMaker.AuthMode	Gets and sets the property AuthMode. The mode of authentication that members use to access the domain.
DefaultSpaceSettings	Amazon.SageMaker.Model.DefaultSpaceSettings	Gets and sets the property DefaultSpaceSettings. The default settings used to create a space.
DefaultUserSettings	Amazon.SageMaker.Model.UserSettings	Gets and sets the property DefaultUserSettings. The default settings to use to create a user profile when `UserSettings` isn't specified in the call to the `CreateUserProfile` API. `SecurityGroups` is aggregated when specified in both calls. For all other settings in `UserSettings`, the values specified in `CreateUserProfile` take precedence over those specified in `CreateDomain`.
DomainName	System.String	Gets and sets the property DomainName. A name for the domain.
DomainSettings	Amazon.SageMaker.Model.DomainSettings	Gets and sets the property DomainSettings. A collection of `Domain` settings.
HomeEfsFileSystemKmsKeyId	System.String	Gets and sets the property HomeEfsFileSystemKmsKeyId. Use `KmsKeyId`.
KmsKeyId	System.String	Gets and sets the property KmsKeyId. 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.
SubnetIds	System.Collections.Generic.List<System.String>	Gets and sets the property SubnetIds. The VPC subnets that the domain uses for communication.
Tags	System.Collections.Generic.List<Amazon.SageMaker.Model.Tag>	Gets and sets the property 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.
VpcId	System.String	Gets and sets the property VpcId. The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5