Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.CreateDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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' {
- appNetworkAccessType :: Maybe AppNetworkAccessType
- appSecurityGroupManagement :: Maybe AppSecurityGroupManagement
- defaultSpaceSettings :: Maybe DefaultSpaceSettings
- domainSettings :: Maybe DomainSettings
- homeEfsFileSystemKmsKeyId :: Maybe Text
- kmsKeyId :: Maybe Text
- tags :: Maybe [Tag]
- domainName :: Text
- authMode :: AuthMode
- defaultUserSettings :: UserSettings
- subnetIds :: NonEmpty Text
- vpcId :: Text
}
newCreateDomain :: Text -> AuthMode -> UserSettings -> NonEmpty Text -> Text -> CreateDomain
createDomain_appNetworkAccessType :: Lens' CreateDomain (Maybe AppNetworkAccessType)
createDomain_appSecurityGroupManagement :: Lens' CreateDomain (Maybe AppSecurityGroupManagement)
createDomain_defaultSpaceSettings :: Lens' CreateDomain (Maybe DefaultSpaceSettings)
createDomain_domainSettings :: Lens' CreateDomain (Maybe DomainSettings)
createDomain_homeEfsFileSystemKmsKeyId :: Lens' CreateDomain (Maybe Text)
createDomain_kmsKeyId :: Lens' CreateDomain (Maybe Text)
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' {
- domainArn :: Maybe Text
- url :: Maybe Text
- httpStatus :: Int
}
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

appNetworkAccessType :: Maybe 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
appSecurityGroupManagement :: Maybe 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.
defaultSpaceSettings :: Maybe DefaultSpaceSettings
The default settings used to create a space.
domainSettings :: Maybe DomainSettings
A collection of Domain settings.
homeEfsFileSystemKmsKeyId :: Maybe Text
Use KmsKeyId.
kmsKeyId :: Maybe Text
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.
tags :: Maybe [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.
domainName :: Text
A name for the domain.
authMode :: AuthMode
The mode of authentication that members use to access the domain.
defaultUserSettings :: 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.
subnetIds :: NonEmpty Text
The VPC subnets that Studio uses for communication.
vpcId :: Text
The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Instances

Instances details

ToJSON CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods toJSON :: CreateDomain -> Value # toEncoding :: CreateDomain -> Encoding # toJSONList :: [CreateDomain] -> Value # toEncodingList :: [CreateDomain] -> Encoding #
ToHeaders CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods toHeaders :: CreateDomain -> [Header] #
ToPath CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods toPath :: CreateDomain -> ByteString #
ToQuery CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods toQuery :: CreateDomain -> QueryString #
AWSRequest CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Associated Types type AWSResponse CreateDomain # Methods request :: (Service -> Service) -> CreateDomain -> Request CreateDomain # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDomain))) #
Generic CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Associated Types type Rep CreateDomain :: Type -> Type # Methods from :: CreateDomain -> Rep CreateDomain x # to :: Rep CreateDomain x -> CreateDomain #
Read CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods readsPrec :: Int -> ReadS CreateDomain # readList :: ReadS [CreateDomain] # readPrec :: ReadPrec CreateDomain # readListPrec :: ReadPrec [CreateDomain] #
Show CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods showsPrec :: Int -> CreateDomain -> ShowS # show :: CreateDomain -> String # showList :: [CreateDomain] -> ShowS #
NFData CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods rnf :: CreateDomain -> () #
Eq CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods (==) :: CreateDomain -> CreateDomain -> Bool # (/=) :: CreateDomain -> CreateDomain -> Bool #
Hashable CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods hashWithSalt :: Int -> CreateDomain -> Int # hash :: CreateDomain -> Int #
type AWSResponse CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain type AWSResponse CreateDomain = CreateDomainResponse
type Rep CreateDomain Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain type Rep CreateDomain = D1 ('MetaData "CreateDomain" "Amazonka.SageMaker.CreateDomain" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateDomain'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "appNetworkAccessType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppNetworkAccessType)) :: (S1 ('MetaSel ('Just "appSecurityGroupManagement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppSecurityGroupManagement)) :: S1 ('MetaSel ('Just "defaultSpaceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultSpaceSettings)))) :: (S1 ('MetaSel ('Just "domainSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainSettings)) :: (S1 ('MetaSel ('Just "homeEfsFileSystemKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "authMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthMode))) :: (S1 ('MetaSel ('Just "defaultUserSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserSettings) :: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateDomain Source #

Arguments

:: Text	`CreateDomain`
-> AuthMode	`$sel:authMode:CreateDomain'`
-> UserSettings	`$sel:defaultUserSettings:CreateDomain'`
-> NonEmpty Text	`$sel:subnetIds:CreateDomain'`
-> Text	`CreateDomain`
-> 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: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 access
VpcOnly - All Studio traffic is through the specified VPC and subnets

$sel:appSecurityGroupManagement:CreateDomain', createDomain_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.

$sel:defaultSpaceSettings:CreateDomain', createDomain_defaultSpaceSettings - The default settings used to create a space.

$sel:domainSettings:CreateDomain', createDomain_domainSettings - A collection of Domain settings.

$sel:homeEfsFileSystemKmsKeyId:CreateDomain', createDomain_homeEfsFileSystemKmsKeyId - Use 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.

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.

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.

CreateDomain, createDomain_vpcId - The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Request Lenses

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 access
VpcOnly - All Studio traffic is through the specified VPC and subnets

createDomain_appSecurityGroupManagement :: Lens' CreateDomain (Maybe AppSecurityGroupManagement) Source #

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.

createDomain_defaultSpaceSettings :: Lens' CreateDomain (Maybe DefaultSpaceSettings) Source #

The default settings used to create a space.

createDomain_domainSettings :: Lens' CreateDomain (Maybe DomainSettings) Source #

A collection of Domain settings.

createDomain_homeEfsFileSystemKmsKeyId :: Lens' CreateDomain (Maybe Text) Source #

Use 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_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'
Fields domainArn :: Maybe Text The Amazon Resource Name (ARN) of the created domain. url :: Maybe Text The URL to the created domain. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Associated Types type Rep CreateDomainResponse :: Type -> Type # Methods from :: CreateDomainResponse -> Rep CreateDomainResponse x # to :: Rep CreateDomainResponse x -> CreateDomainResponse #
Read CreateDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods readsPrec :: Int -> ReadS CreateDomainResponse # readList :: ReadS [CreateDomainResponse] # readPrec :: ReadPrec CreateDomainResponse # readListPrec :: ReadPrec [CreateDomainResponse] #
Show CreateDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods showsPrec :: Int -> CreateDomainResponse -> ShowS # show :: CreateDomainResponse -> String # showList :: [CreateDomainResponse] -> ShowS #
NFData CreateDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods rnf :: CreateDomainResponse -> () #
Eq CreateDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain Methods (==) :: CreateDomainResponse -> CreateDomainResponse -> Bool # (/=) :: CreateDomainResponse -> CreateDomainResponse -> Bool #
type Rep CreateDomainResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateDomain type Rep CreateDomainResponse = D1 ('MetaData "CreateDomainResponse" "Amazonka.SageMaker.CreateDomain" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDomainResponse'`
-> 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:

CreateDomainResponse, createDomainResponse_domainArn - The Amazon Resource Name (ARN) of the created domain.

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.