All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateDomainRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  UpdateDomainRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  UpdateDomainRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getAppNetworkAccessType () Specifies the VPC used for non-EFS traffic.
  String	getAppSecurityGroupManagement () The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
  DefaultSpaceSettings	getDefaultSpaceSettings () The default settings used to create a space within the domain.
  UserSettings	getDefaultUserSettings () A collection of settings.
  String	getDomainId () The ID of the domain to be updated.
  DomainSettingsForUpdate	getDomainSettingsForUpdate () A collection of DomainSettings configuration values to update.
  List<String>	getSubnetIds () The VPC subnets that Studio uses for communication.
  int	hashCode ()
  void	setAppNetworkAccessType (String appNetworkAccessType) Specifies the VPC used for non-EFS traffic.
  void	setAppSecurityGroupManagement (String appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
  void	setDefaultSpaceSettings (DefaultSpaceSettings defaultSpaceSettings) The default settings used to create a space within the domain.
  void	setDefaultUserSettings (UserSettings defaultUserSettings) A collection of settings.
  void	setDomainId (String domainId) The ID of the domain to be updated.
  void	setDomainSettingsForUpdate (DomainSettingsForUpdate domainSettingsForUpdate) A collection of DomainSettings configuration values to update.
  void	setSubnetIds (Collection<String> subnetIds) The VPC subnets that Studio uses for communication.
  String	toString () Returns a string representation of this object.
  UpdateDomainRequest	withAppNetworkAccessType (AppNetworkAccessType appNetworkAccessType) Specifies the VPC used for non-EFS traffic.
  UpdateDomainRequest	withAppNetworkAccessType (String appNetworkAccessType) Specifies the VPC used for non-EFS traffic.
  UpdateDomainRequest	withAppSecurityGroupManagement (AppSecurityGroupManagement appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
  UpdateDomainRequest	withAppSecurityGroupManagement (String appSecurityGroupManagement) The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode.
  UpdateDomainRequest	withDefaultSpaceSettings (DefaultSpaceSettings defaultSpaceSettings) The default settings used to create a space within the domain.
  UpdateDomainRequest	withDefaultUserSettings (UserSettings defaultUserSettings) A collection of settings.
  UpdateDomainRequest	withDomainId (String domainId) The ID of the domain to be updated.
  UpdateDomainRequest	withDomainSettingsForUpdate (DomainSettingsForUpdate domainSettingsForUpdate) A collection of DomainSettings configuration values to update.
  UpdateDomainRequest	withSubnetIds (Collection<String> subnetIds) The VPC subnets that Studio uses for communication.
  UpdateDomainRequest	withSubnetIds (String... subnetIds) The VPC subnets that Studio uses for communication.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • UpdateDomainRequest

    public UpdateDomainRequest()

• Method Detail

  • setDomainId

    public void setDomainId(String domainId)

    The ID of the domain to be updated.

    Parameters:

    domainId - The ID of the domain to be updated.

  • getDomainId

    public String getDomainId()

    The ID of the domain to be updated.

    Returns:

    The ID of the domain to be updated.

  • withDomainId

    public UpdateDomainRequest withDomainId(String domainId)

    The ID of the domain to be updated.

    Parameters:

    domainId - The ID of the domain to be updated.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setDefaultUserSettings

    public void setDefaultUserSettings(UserSettings defaultUserSettings)

    A collection of settings.

    Parameters:

    defaultUserSettings - A collection of settings.

  • getDefaultUserSettings

    public UserSettings getDefaultUserSettings()

    A collection of settings.

    Returns:

    A collection of settings.

  • withDefaultUserSettings

    public UpdateDomainRequest withDefaultUserSettings(UserSettings defaultUserSettings)

    A collection of settings.

    Parameters:

    defaultUserSettings - A collection of settings.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setDomainSettingsForUpdate

    public void setDomainSettingsForUpdate(DomainSettingsForUpdate domainSettingsForUpdate)

    A collection of DomainSettings configuration values to update.

    Parameters:

    domainSettingsForUpdate - A collection of DomainSettings configuration values to update.

  • getDomainSettingsForUpdate

    public DomainSettingsForUpdate getDomainSettingsForUpdate()

    A collection of DomainSettings configuration values to update.

    Returns:

    A collection of DomainSettings configuration values to update.

  • withDomainSettingsForUpdate

    public UpdateDomainRequest withDomainSettingsForUpdate(DomainSettingsForUpdate domainSettingsForUpdate)

    A collection of DomainSettings configuration values to update.

    Parameters:

    domainSettingsForUpdate - A collection of DomainSettings configuration values to update.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setAppSecurityGroupManagement

    public void setAppSecurityGroupManagement(String 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.

    Parameters:

    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 .

    See Also:

    AppSecurityGroupManagement

  • getAppSecurityGroupManagement

    public String getAppSecurityGroupManagement()

    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.

    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

  • withAppSecurityGroupManagement

    public UpdateDomainRequest withAppSecurityGroupManagement(String 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.

    Parameters:

    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 .

    Returns:

    Returns a reference to this object so that method calls can be chained together.

    See Also:

    AppSecurityGroupManagement

  • withAppSecurityGroupManagement

    public UpdateDomainRequest withAppSecurityGroupManagement(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.

    Parameters:

    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 .

    Returns:

    Returns a reference to this object so that method calls can be chained together.

    See Also:

    AppSecurityGroupManagement

  • setDefaultSpaceSettings

    public void setDefaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings)

    The default settings used to create a space within the domain.

    Parameters:

    defaultSpaceSettings - The default settings used to create a space within the domain.

  • getDefaultSpaceSettings

    public DefaultSpaceSettings getDefaultSpaceSettings()

    The default settings used to create a space within the domain.

    Returns:

    The default settings used to create a space within the domain.

  • withDefaultSpaceSettings

    public UpdateDomainRequest withDefaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings)

    The default settings used to create a space within the domain.

    Parameters:

    defaultSpaceSettings - The default settings used to create a space within the domain.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • getSubnetIds

    public List<String> getSubnetIds()

    The VPC subnets that Studio uses for communication.

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

    Returns:

    The VPC subnets that Studio uses for communication.

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

  • setSubnetIds

    public void setSubnetIds(Collection<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.

    Parameters:

    subnetIds - The VPC subnets that Studio uses for communication.

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

  • withSubnetIds

    public UpdateDomainRequest withSubnetIds(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.

    NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.

    Parameters:

    subnetIds - The VPC subnets that Studio uses for communication.

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withSubnetIds

    public UpdateDomainRequest withSubnetIds(Collection<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.

    Parameters:

    subnetIds - The VPC subnets that Studio uses for communication.

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setAppNetworkAccessType

    public void setAppNetworkAccessType(String appNetworkAccessType)

    Specifies the VPC used for non-EFS traffic.

    • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, 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.

    Parameters:

    appNetworkAccessType - Specifies the VPC used for non-EFS traffic.

    • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, 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

  • getAppNetworkAccessType

    public String getAppNetworkAccessType()

    Specifies the VPC used for non-EFS traffic.

    • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, 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.

    Returns:

    Specifies the VPC used for non-EFS traffic.

    • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, 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

  • withAppNetworkAccessType

    public UpdateDomainRequest withAppNetworkAccessType(String appNetworkAccessType)

    Specifies the VPC used for non-EFS traffic.

    • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, 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.

    Parameters:

    appNetworkAccessType - Specifies the VPC used for non-EFS traffic.

    • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, 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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

    See Also:

    AppNetworkAccessType

  • withAppNetworkAccessType

    public UpdateDomainRequest withAppNetworkAccessType(AppNetworkAccessType appNetworkAccessType)

    Specifies the VPC used for non-EFS traffic.

    • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, 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.

    Parameters:

    appNetworkAccessType - Specifies the VPC used for non-EFS traffic.

    • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, 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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

    See Also:

    AppNetworkAccessType

  • toString

    public 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public UpdateDomainRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()