Package software.amazon.awssdk.services.sagemaker.model

Class CreateDomainRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateDomainRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDomainRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDomainRequest.Builder

Method Summary

Modifier and Type	Method	Description
AppNetworkAccessType	appNetworkAccessType()	Specifies the VPC used for non-EFS traffic.
String	appNetworkAccessTypeAsString()	Specifies the VPC used for non-EFS traffic.
AppSecurityGroupManagement	appSecurityGroupManagement()	The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
String	appSecurityGroupManagementAsString()	The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
AuthMode	authMode()	The mode of authentication that members use to access the domain.
String	authModeAsString()	The mode of authentication that members use to access the domain.
static CreateDomainRequest.Builder	builder()
DefaultSpaceSettings	defaultSpaceSettings()	The default settings for shared spaces that users create in the domain.
UserSettings	defaultUserSettings()	The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.
String	domainName()	A name for the domain.
DomainSettings	domainSettings()	A collection of Domain settings.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubnetIds()	For responses, this returns true if the service returned a value for the SubnetIds property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	homeEfsFileSystemKmsKeyId()	Deprecated. This property is deprecated, use KmsKeyId instead.
String	kmsKeyId()	SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDomainRequest.Builder>	serializableBuilderClass()
List<String>	subnetIds()	The VPC subnets that the domain uses for communication.
TagPropagation	tagPropagation()	Indicates whether custom tag propagation is supported for the domain.
String	tagPropagationAsString()	Indicates whether custom tag propagation is supported for the domain.
List<Tag>	tags()	Tags to associated with the Domain.
CreateDomainRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vpcId()	The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domainName

public final String domainName()

A name for the domain.

Returns:

A name for the domain.

authMode

public final AuthMode authMode()

The mode of authentication that members use to access the domain.

If the service returns an enum value that is not available in the current SDK version, authMode will return AuthMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authModeAsString().

Returns:

The mode of authentication that members use to access the domain.

See Also:

AuthMode

authModeAsString

public final String authModeAsString()

The mode of authentication that members use to access the domain.

If the service returns an enum value that is not available in the current SDK version, authMode will return AuthMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authModeAsString().

Returns:

The mode of authentication that members use to access the domain.

See Also:

AuthMode

defaultUserSettings

public final UserSettings 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.

Returns:

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.

domainSettings

public final DomainSettings domainSettings()

A collection of Domain settings.

Returns:

A collection of Domain settings.

hasSubnetIds

public final boolean hasSubnetIds()

For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

subnetIds

public final List<String> subnetIds()

The VPC subnets that the domain uses for communication.

The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

Returns:

The VPC subnets that the domain uses for communication.

The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.

vpcId

public final String vpcId()

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.

Returns:

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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.

appNetworkAccessType

public final 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 AI, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

If the service returns an enum value that is not available in the current SDK version, appNetworkAccessType will return AppNetworkAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from appNetworkAccessTypeAsString().

Returns:

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 AI, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

See Also:

AppNetworkAccessType

appNetworkAccessTypeAsString

public final String appNetworkAccessTypeAsString()

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 AI, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

If the service returns an enum value that is not available in the current SDK version, appNetworkAccessType will return AppNetworkAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from appNetworkAccessTypeAsString().

Returns:

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 AI, which allows direct internet access

• VpcOnly - All traffic is through the specified VPC and subnets

See Also:

AppNetworkAccessType

homeEfsFileSystemKmsKeyId

@Deprecated
public final String homeEfsFileSystemKmsKeyId()

Deprecated.

This property is deprecated, use KmsKeyId instead.

Use KmsKeyId.

Returns:

Use KmsKeyId.

kmsKeyId

public final String kmsKeyId()

SageMaker AI 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:

SageMaker AI 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.

appSecurityGroupManagement

public final 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. If setting up the domain for use with RStudio, this value must be set to Service.

If the service returns an enum value that is not available in the current SDK version, appSecurityGroupManagement will return AppSecurityGroupManagement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from appSecurityGroupManagementAsString().

Returns:

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.

See Also:

AppSecurityGroupManagement

appSecurityGroupManagementAsString

public final String appSecurityGroupManagementAsString()

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.

If the service returns an enum value that is not available in the current SDK version, appSecurityGroupManagement will return AppSecurityGroupManagement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from appSecurityGroupManagementAsString().

Returns:

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.

See Also:

AppSecurityGroupManagement

tagPropagation

public final TagPropagation tagPropagation()

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

If the service returns an enum value that is not available in the current SDK version, tagPropagation will return TagPropagation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tagPropagationAsString().

Returns:

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

See Also:

TagPropagation

tagPropagationAsString

public final String tagPropagationAsString()

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

If the service returns an enum value that is not available in the current SDK version, tagPropagation will return TagPropagation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tagPropagationAsString().

Returns:

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

See Also:

TagPropagation

defaultSpaceSettings

public final DefaultSpaceSettings defaultSpaceSettings()

The default settings for shared spaces that users create in the domain.

Returns:

The default settings for shared spaces that users create in the domain.

toBuilder

public CreateDomainRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateDomainRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDomainRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo