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

Class UnifiedStudioSettings

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.UnifiedStudioSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UnifiedStudioSettings.Builder,UnifiedStudioSettings>

@Generated("software.amazon.awssdk:codegen")
public final class UnifiedStudioSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UnifiedStudioSettings.Builder,UnifiedStudioSettings>

The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UnifiedStudioSettings.Builder

Method Summary

Modifier and Type	Method	Description
static UnifiedStudioSettings.Builder	builder()
String	domainAccountId()	The ID of the Amazon Web Services account that has the Amazon SageMaker Unified Studio domain.
String	domainId()	The ID of the Amazon SageMaker Unified Studio domain associated with this domain.
String	domainRegion()	The Amazon Web Services Region where the domain is located in Amazon SageMaker Unified Studio.
String	environmentId()	The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	projectId()	The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.
String	projectS3Path()	The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UnifiedStudioSettings.Builder>	serializableBuilderClass()
String	singleSignOnApplicationArn()	The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.
FeatureStatus	studioWebPortalAccess()	Sets whether you can access the domain in Amazon SageMaker Studio:
String	studioWebPortalAccessAsString()	Sets whether you can access the domain in Amazon SageMaker Studio:
UnifiedStudioSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

studioWebPortalAccess

public final FeatureStatus studioWebPortalAccess()

Sets whether you can access the domain in Amazon SageMaker Studio:

ENABLED

You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.

DISABLED

You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.

To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.

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

Returns:

Sets whether you can access the domain in Amazon SageMaker Studio:

ENABLED

You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.

DISABLED

You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.

To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.

See Also:

FeatureStatus

studioWebPortalAccessAsString

public final String studioWebPortalAccessAsString()

Sets whether you can access the domain in Amazon SageMaker Studio:

ENABLED

You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.

DISABLED

You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.

To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.

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

Returns:

Sets whether you can access the domain in Amazon SageMaker Studio:

ENABLED

You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.

DISABLED

You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.

To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.

See Also:

FeatureStatus

domainAccountId

public final String domainAccountId()

The ID of the Amazon Web Services account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.

Returns:

The ID of the Amazon Web Services account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.

domainRegion

public final String domainRegion()

The Amazon Web Services Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.

Returns:

The Amazon Web Services Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.

domainId

public final String domainId()

The ID of the Amazon SageMaker Unified Studio domain associated with this domain.

Returns:

The ID of the Amazon SageMaker Unified Studio domain associated with this domain.

projectId

public final String projectId()

The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.

Returns:

The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.

environmentId

public final String environmentId()

The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.

Returns:

The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.

projectS3Path

public final String projectS3Path()

The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.

Returns:

The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.

singleSignOnApplicationArn

public final String singleSignOnApplicationArn()

The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.

Returns:

The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.

toBuilder

public UnifiedStudioSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UnifiedStudioSettings.Builder,UnifiedStudioSettings>

builder

public static UnifiedStudioSettings.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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