Interface CreateDomainRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateDomainRequest.Builder,
,CreateDomainRequest> SageMakerRequest.Builder
,SdkBuilder<CreateDomainRequest.Builder,
,CreateDomainRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateDomainRequest
-
Method Summary
Modifier and TypeMethodDescriptionappNetworkAccessType
(String appNetworkAccessType) Specifies the VPC used for non-EFS traffic.appNetworkAccessType
(AppNetworkAccessType appNetworkAccessType) Specifies the VPC used for non-EFS traffic.appSecurityGroupManagement
(String appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication inVPCOnly
mode.appSecurityGroupManagement
(AppSecurityGroupManagement appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication inVPCOnly
mode.The mode of authentication that members use to access the domain.The mode of authentication that members use to access the domain.default CreateDomainRequest.Builder
defaultSpaceSettings
(Consumer<DefaultSpaceSettings.Builder> defaultSpaceSettings) The default settings used to create a space.defaultSpaceSettings
(DefaultSpaceSettings defaultSpaceSettings) The default settings used to create a space.default CreateDomainRequest.Builder
defaultUserSettings
(Consumer<UserSettings.Builder> defaultUserSettings) The default settings to use to create a user profile whenUserSettings
isn't specified in the call to theCreateUserProfile
API.defaultUserSettings
(UserSettings defaultUserSettings) The default settings to use to create a user profile whenUserSettings
isn't specified in the call to theCreateUserProfile
API.domainName
(String domainName) A name for the domain.default CreateDomainRequest.Builder
domainSettings
(Consumer<DomainSettings.Builder> domainSettings) A collection ofDomain
settings.domainSettings
(DomainSettings domainSettings) A collection ofDomain
settings.homeEfsFileSystemKmsKeyId
(String homeEfsFileSystemKmsKeyId) Deprecated.This property is deprecated, use KmsKeyId instead.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.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The VPC subnets that the domain uses for communication.subnetIds
(Collection<String> subnetIds) The VPC subnets that the domain uses for communication.tags
(Collection<Tag> tags) Tags to associated with the Domain.tags
(Consumer<Tag.Builder>... tags) Tags to associated with the Domain.Tags to associated with the Domain.The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
domainName
A name for the domain.
- Parameters:
domainName
- A name for the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authMode
The mode of authentication that members use to access the domain.
- Parameters:
authMode
- The mode of authentication that members use to access the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authMode
The mode of authentication that members use to access the domain.
- Parameters:
authMode
- The mode of authentication that members use to access the domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
defaultUserSettings
The default settings to use to create a user profile when
UserSettings
isn't specified in the call to theCreateUserProfile
API.SecurityGroups
is aggregated when specified in both calls. For all other settings inUserSettings
, the values specified inCreateUserProfile
take precedence over those specified inCreateDomain
.- Parameters:
defaultUserSettings
- The default settings to use to create a user profile whenUserSettings
isn't specified in the call to theCreateUserProfile
API.SecurityGroups
is aggregated when specified in both calls. For all other settings inUserSettings
, the values specified inCreateUserProfile
take precedence over those specified inCreateDomain
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultUserSettings
default CreateDomainRequest.Builder defaultUserSettings(Consumer<UserSettings.Builder> defaultUserSettings) The default settings to use to create a user profile when
UserSettings
isn't specified in the call to theCreateUserProfile
API.SecurityGroups
is aggregated when specified in both calls. For all other settings inUserSettings
, the values specified inCreateUserProfile
take precedence over those specified inCreateDomain
.UserSettings.Builder
avoiding the need to create one manually viaUserSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultUserSettings(UserSettings)
.- Parameters:
defaultUserSettings
- a consumer that will call methods onUserSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
domainSettings
A collection of
Domain
settings.- Parameters:
domainSettings
- A collection ofDomain
settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainSettings
A collection of
This is a convenience method that creates an instance of theDomain
settings.DomainSettings.Builder
avoiding the need to create one manually viaDomainSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todomainSettings(DomainSettings)
.- Parameters:
domainSettings
- a consumer that will call methods onDomainSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
subnetIds
The VPC subnets that the domain uses for communication.
- Parameters:
subnetIds
- The VPC subnets that the domain uses for communication.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
The VPC subnets that the domain uses for communication.
- Parameters:
subnetIds
- The VPC subnets that the domain uses for communication.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcId
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
- Parameters:
vpcId
- The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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 theSearch
API.Tags that you specify for the Domain are also added to all Apps that the Domain launches.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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 theSearch
API.Tags that you specify for the Domain are also added to all Apps that the Domain launches.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
- Parameters:
appNetworkAccessType
- Specifies the VPC used for non-EFS traffic. The default value isPublicInternetOnly
.-
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
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
- Parameters:
appNetworkAccessType
- Specifies the VPC used for non-EFS traffic. The default value isPublicInternetOnly
.-
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
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
homeEfsFileSystemKmsKeyId
Deprecated.This property is deprecated, use KmsKeyId instead.Use
KmsKeyId
.- Parameters:
homeEfsFileSystemKmsKeyId
- UseKmsKeyId
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
appSecurityGroupManagement
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required whenCreateDomain.AppNetworkAccessType
isVPCOnly
andDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided. If setting up the domain for use with RStudio, this value must be set toService
.- Parameters:
appSecurityGroupManagement
- The entity that creates and manages the required security groups for inter-app communication inVPCOnly
mode. Required whenCreateDomain.AppNetworkAccessType
isVPCOnly
andDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided. If setting up the domain for use with RStudio, this value must be set toService
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
appSecurityGroupManagement
CreateDomainRequest.Builder appSecurityGroupManagement(AppSecurityGroupManagement appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required whenCreateDomain.AppNetworkAccessType
isVPCOnly
andDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided. If setting up the domain for use with RStudio, this value must be set toService
.- Parameters:
appSecurityGroupManagement
- The entity that creates and manages the required security groups for inter-app communication inVPCOnly
mode. Required whenCreateDomain.AppNetworkAccessType
isVPCOnly
andDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided. If setting up the domain for use with RStudio, this value must be set toService
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
defaultSpaceSettings
The default settings used to create a space.
- Parameters:
defaultSpaceSettings
- The default settings used to create a space.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultSpaceSettings
default CreateDomainRequest.Builder defaultSpaceSettings(Consumer<DefaultSpaceSettings.Builder> defaultSpaceSettings) The default settings used to create a space.
This is a convenience method that creates an instance of theDefaultSpaceSettings.Builder
avoiding the need to create one manually viaDefaultSpaceSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultSpaceSettings(DefaultSpaceSettings)
.- Parameters:
defaultSpaceSettings
- a consumer that will call methods onDefaultSpaceSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateDomainRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateDomainRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-