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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateDomainRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`static UpdateDomainRequest.Builder`	`builder()`
`DefaultSpaceSettings`	`defaultSpaceSettings()`	The default settings for shared spaces that users create in the domain.
`UserSettings`	`defaultUserSettings()`	A collection of settings.
`String`	`domainId()`	The ID of the domain to be updated.
`DomainSettingsForUpdate`	`domainSettingsForUpdate()`	A collection of `DomainSettings` configuration values to update.
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateDomainRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`subnetIds()`	The VPC subnets that Studio 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.
`UpdateDomainRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - 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:
    
    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
  - 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:
    
    AppNetworkAccessType
  - 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:
    
    AppNetworkAccessType
  - 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
  - toBuilder
```
public UpdateDomainRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateDomainRequest.Builder,UpdateDomainRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - 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)
```
    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

Class UpdateDomainRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

domainId

defaultUserSettings

domainSettingsForUpdate

appSecurityGroupManagement

appSecurityGroupManagementAsString

defaultSpaceSettings

hasSubnetIds

subnetIds

appNetworkAccessType

appNetworkAccessTypeAsString

tagPropagation

tagPropagationAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField