Package software.amazon.awssdk.services.sagemaker.model

Interface UpdateDomainRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateDomainRequest.Builder,UpdateDomainRequest>, SageMakerRequest.Builder, SdkBuilder<UpdateDomainRequest.Builder,UpdateDomainRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateDomainRequest
public static interface UpdateDomainRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<UpdateDomainRequest.Builder,UpdateDomainRequest>

  • Method Details

    • domainId

      UpdateDomainRequest.Builder domainId(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.

    • defaultUserSettings

      UpdateDomainRequest.Builder defaultUserSettings(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.

    • defaultUserSettings

      default UpdateDomainRequest.Builder defaultUserSettings(Consumer<UserSettings.Builder> defaultUserSettings)

      A collection of settings.

      This is a convenience method that creates an instance of the UserSettings.Builder avoiding the need to create one manually via UserSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultUserSettings(UserSettings).

      Parameters:
      defaultUserSettings - a consumer that will call methods on UserSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • domainSettingsForUpdate

      UpdateDomainRequest.Builder domainSettingsForUpdate(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.

    • domainSettingsForUpdate

      default UpdateDomainRequest.Builder domainSettingsForUpdate(Consumer<DomainSettingsForUpdate.Builder> domainSettingsForUpdate)

      A collection of DomainSettings configuration values to update.

      This is a convenience method that creates an instance of the DomainSettingsForUpdate.Builder avoiding the need to create one manually via DomainSettingsForUpdate.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to domainSettingsForUpdate(DomainSettingsForUpdate).

      Parameters:
      domainSettingsForUpdate - a consumer that will call methods on DomainSettingsForUpdate.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • appSecurityGroupManagement

      UpdateDomainRequest.Builder appSecurityGroupManagement(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

      UpdateDomainRequest.Builder appSecurityGroupManagement(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:

    • defaultSpaceSettings

      UpdateDomainRequest.Builder defaultSpaceSettings(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.

    • defaultSpaceSettings

      default UpdateDomainRequest.Builder defaultSpaceSettings(Consumer<DefaultSpaceSettings.Builder> defaultSpaceSettings)

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

      This is a convenience method that creates an instance of the DefaultSpaceSettings.Builder avoiding the need to create one manually via DefaultSpaceSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultSpaceSettings(DefaultSpaceSettings).

      Parameters:
      defaultSpaceSettings - a consumer that will call methods on DefaultSpaceSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • subnetIds

      UpdateDomainRequest.Builder subnetIds(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.

    • subnetIds

      UpdateDomainRequest.Builder subnetIds(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.

    • appNetworkAccessType

      UpdateDomainRequest.Builder appNetworkAccessType(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

      UpdateDomainRequest.Builder appNetworkAccessType(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:

    • overrideConfiguration

      UpdateDomainRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateDomainRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.