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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UnifiedStudioSettings.Builder,UnifiedStudioSettings>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.