AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon SageMaker Service CreateDomain API operation.

Syntax

New-SMDomain
-DomainName <String>
-AppNetworkAccessType <AppNetworkAccessType>
-AppSecurityGroupManagement <AppSecurityGroupManagement>
-AuthMode <AuthMode>
-DefaultUserSetting <UserSettings>
-RStudioServerProDomainSettings_DomainExecutionRoleArn <String>
-DefaultResourceSpec_InstanceType <AppInstanceType>
-KmsKeyId <String>
-DefaultResourceSpec_LifecycleConfigArn <String>
-RStudioServerProDomainSettings_RStudioConnectUrl <String>
-RStudioServerProDomainSettings_RStudioPackageManagerUrl <String>
-DefaultResourceSpec_SageMakerImageArn <String>
-DefaultResourceSpec_SageMakerImageVersionArn <String>
-DomainSettings_SecurityGroupId <String[]>
-SubnetId <String[]>
-Tag <Tag[]>
-VpcId <String>
-HomeEfsFileSystemKmsKeyId <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

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 Amazon Web Services 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 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 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.
NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a SageMaker Studio app successfully. For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.

Parameters

-AppNetworkAccessType <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 Studio traffic is through the specified VPC and subnets
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppSecurityGroupManagement <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuthMode <AuthMode>
The mode of authentication that members use to access the domain.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultResourceSpec_InstanceType <AppInstanceType>
The instance type that the image version runs on.JupyterServer apps only support the system value.For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettings_RStudioServerProDomainSettings_DefaultResourceSpec_InstanceType
-DefaultResourceSpec_LifecycleConfigArn <String>
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettings_RStudioServerProDomainSettings_DefaultResourceSpec_LifecycleConfigArn
-DefaultResourceSpec_SageMakerImageArn <String>
The ARN of the SageMaker image that the image version belongs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettings_RStudioServerProDomainSettings_DefaultResourceSpec_SageMakerImageArn
-DefaultResourceSpec_SageMakerImageVersionArn <String>
The ARN of the image version created on the instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettings_RStudioServerProDomainSettings_DefaultResourceSpec_SageMakerImageVersionArn
-DefaultUserSetting <UserSettings>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultUserSettings
-DomainName <String>
A name for the domain.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DomainSettings_SecurityGroupId <String[]>
The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettings_SecurityGroupIds
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HomeEfsFileSystemKmsKeyId <String>
Use KmsKeyId.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <String>
SageMaker uses 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, specify a customer managed key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RStudioServerProDomainSettings_DomainExecutionRoleArn <String>
The ARN of the execution role for the RStudioServerPro Domain-level app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettings_RStudioServerProDomainSettings_DomainExecutionRoleArn
-RStudioServerProDomainSettings_RStudioConnectUrl <String>
A URL pointing to an RStudio Connect server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettings_RStudioServerProDomainSettings_RStudioConnectUrl
-RStudioServerProDomainSettings_RStudioPackageManagerUrl <String>
A URL pointing to an RStudio Package Manager server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettings_RStudioServerProDomainSettings_RStudioPackageManagerUrl
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateDomainResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SubnetId <String[]>
The VPC subnets that Studio uses for communication.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnetIds
-Tag <Tag[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VpcId <String>
The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.SageMaker.Model.CreateDomainResponse
This cmdlet returns an Amazon.SageMaker.Model.CreateDomainResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z