Class DomainSettingsForUpdate

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.DomainSettingsForUpdate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DomainSettingsForUpdate.Builder,DomainSettingsForUpdate>
@Generated("software.amazon.awssdk:codegen") public final class DomainSettingsForUpdate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DomainSettingsForUpdate.Builder,DomainSettingsForUpdate>

A collection of Domain configuration settings to update.

See Also:

  • Method Details

    • rStudioServerProDomainSettingsForUpdate

      public final RStudioServerProDomainSettingsForUpdate rStudioServerProDomainSettingsForUpdate()

      A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

      Returns:
      A collection of RStudioServerPro Domain-level app settings to update. A single RStudioServerPro application is created for a domain.

    • executionRoleIdentityConfig

      public final ExecutionRoleIdentityConfig executionRoleIdentityConfig()

      The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

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

      Returns:
      The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.
      See Also:

    • executionRoleIdentityConfigAsString

      public final String executionRoleIdentityConfigAsString()

      The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

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

      Returns:
      The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.
      See Also:

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds 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.

    • securityGroupIds

      public final List<String> securityGroupIds()

      The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

      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 hasSecurityGroupIds() method.

      Returns:
      The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

    • dockerSettings

      public final DockerSettings dockerSettings()

      A collection of settings that configure the domain's Docker interaction.

      Returns:
      A collection of settings that configure the domain's Docker interaction.

    • amazonQSettings

      public final AmazonQSettings amazonQSettings()

      A collection of settings that configure the Amazon Q experience within the domain.

      Returns:
      A collection of settings that configure the Amazon Q experience within the domain.

    • unifiedStudioSettings

      public final UnifiedStudioSettings unifiedStudioSettings()

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

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

    • toBuilder

      public DomainSettingsForUpdate.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<DomainSettingsForUpdate.Builder,DomainSettingsForUpdate>
      Returns:
      a builder for type T

    • builder

      public static DomainSettingsForUpdate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DomainSettingsForUpdate.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.