Class UpdateDomainRequest

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.UpdateDomainRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateDomainRequest.Builder,UpdateDomainRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateDomainRequest extends SageMakerRequest implements ToCopyableBuilder<UpdateDomainRequest.Builder,UpdateDomainRequest>

  • Method Details

    • domainId

      public final String domainId()

      The ID of the domain to be updated.

      Returns:
      The ID of the domain to be updated.

    • defaultUserSettings

      public final UserSettings defaultUserSettings()

      A collection of settings.

      Returns:
      A collection of settings.

    • domainSettingsForUpdate

      public final DomainSettingsForUpdate domainSettingsForUpdate()

      A collection of DomainSettings configuration values to update.

      Returns:
      A collection of DomainSettings configuration values to update.

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

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

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

    • 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 Studio uses for communication.

      If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.

      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 Studio uses for communication.

      If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state.

    • appNetworkAccessType

      public final AppNetworkAccessType appNetworkAccessType()

      Specifies the VPC used for non-EFS traffic.

      • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.

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

      This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

      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.

      • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.

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

      This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

      See Also:

    • appNetworkAccessTypeAsString

      public final String appNetworkAccessTypeAsString()

      Specifies the VPC used for non-EFS traffic.

      • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.

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

      This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

      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.

      • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.

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

      This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.

      See Also:

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

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

    • toBuilder

      public UpdateDomainRequest.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<UpdateDomainRequest.Builder,UpdateDomainRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateDomainRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateDomainRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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