Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Amazonka.SageMaker.CreateDomain
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.
Synopsis
- data CreateDomain = CreateDomain' {}
- newCreateDomain :: Text -> AuthMode -> UserSettings -> NonEmpty Text -> Text -> CreateDomain
- createDomain_homeEfsFileSystemKmsKeyId :: Lens' CreateDomain (Maybe Text)
- createDomain_kmsKeyId :: Lens' CreateDomain (Maybe Text)
- createDomain_appNetworkAccessType :: Lens' CreateDomain (Maybe AppNetworkAccessType)
- createDomain_tags :: Lens' CreateDomain (Maybe [Tag])
- createDomain_domainName :: Lens' CreateDomain Text
- createDomain_authMode :: Lens' CreateDomain AuthMode
- createDomain_defaultUserSettings :: Lens' CreateDomain UserSettings
- createDomain_subnetIds :: Lens' CreateDomain (NonEmpty Text)
- createDomain_vpcId :: Lens' CreateDomain Text
- data CreateDomainResponse = CreateDomainResponse' {}
- newCreateDomainResponse :: Int -> CreateDomainResponse
- createDomainResponse_domainArn :: Lens' CreateDomainResponse (Maybe Text)
- createDomainResponse_url :: Lens' CreateDomainResponse (Maybe Text)
- createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int
Creating a Request
data CreateDomain Source #
See: newCreateDomain
smart constructor.
Constructors
CreateDomain' | |
Fields
|
Instances
Arguments
:: Text | |
-> AuthMode | |
-> UserSettings | |
-> NonEmpty Text | |
-> Text | |
-> CreateDomain |
Create a value of CreateDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:homeEfsFileSystemKmsKeyId:CreateDomain'
, createDomain_homeEfsFileSystemKmsKeyId
- This member is deprecated and replaced with KmsKeyId
.
$sel:kmsKeyId:CreateDomain'
, createDomain_kmsKeyId
- 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.
$sel:appNetworkAccessType:CreateDomain'
, createDomain_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 accessVpcOnly
- All Studio traffic is through the specified VPC and subnets
$sel:tags:CreateDomain'
, createDomain_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.
$sel:domainName:CreateDomain'
, createDomain_domainName
- A name for the domain.
$sel:authMode:CreateDomain'
, createDomain_authMode
- The mode of authentication that members use to access the domain.
$sel:defaultUserSettings:CreateDomain'
, createDomain_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
.
$sel:subnetIds:CreateDomain'
, createDomain_subnetIds
- The VPC subnets that Studio uses for communication.
$sel:vpcId:CreateDomain'
, createDomain_vpcId
- The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for
communication.
Request Lenses
createDomain_homeEfsFileSystemKmsKeyId :: Lens' CreateDomain (Maybe Text) Source #
This member is deprecated and replaced with KmsKeyId
.
createDomain_kmsKeyId :: Lens' CreateDomain (Maybe Text) Source #
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.
createDomain_appNetworkAccessType :: Lens' CreateDomain (Maybe AppNetworkAccessType) Source #
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 accessVpcOnly
- All Studio traffic is through the specified VPC and subnets
createDomain_tags :: Lens' CreateDomain (Maybe [Tag]) Source #
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.
createDomain_domainName :: Lens' CreateDomain Text Source #
A name for the domain.
createDomain_authMode :: Lens' CreateDomain AuthMode Source #
The mode of authentication that members use to access the domain.
createDomain_defaultUserSettings :: Lens' CreateDomain UserSettings Source #
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
.
createDomain_subnetIds :: Lens' CreateDomain (NonEmpty Text) Source #
The VPC subnets that Studio uses for communication.
createDomain_vpcId :: Lens' CreateDomain Text Source #
The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Destructuring the Response
data CreateDomainResponse Source #
See: newCreateDomainResponse
smart constructor.
Constructors
CreateDomainResponse' | |
Instances
newCreateDomainResponse Source #
Arguments
:: Int | |
-> CreateDomainResponse |
Create a value of CreateDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainArn:CreateDomainResponse'
, createDomainResponse_domainArn
- The Amazon Resource Name (ARN) of the created domain.
$sel:url:CreateDomainResponse'
, createDomainResponse_url
- The URL to the created domain.
$sel:httpStatus:CreateDomainResponse'
, createDomainResponse_httpStatus
- The response's http status code.
Response Lenses
createDomainResponse_domainArn :: Lens' CreateDomainResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the created domain.
createDomainResponse_url :: Lens' CreateDomainResponse (Maybe Text) Source #
The URL to the created domain.
createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #
The response's http status code.