software.amazon.awssdk.services.sagemaker.model.UpdateDomainRequest Maven / Gradle / Ivy
Show all versions of sagemaker Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemaker.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateDomainRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DomainId").getter(getter(UpdateDomainRequest::domainId)).setter(setter(Builder::domainId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainId").build()).build();
private static final SdkField DEFAULT_USER_SETTINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DefaultUserSettings")
.getter(getter(UpdateDomainRequest::defaultUserSettings)).setter(setter(Builder::defaultUserSettings))
.constructor(UserSettings::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultUserSettings").build())
.build();
private static final SdkField DOMAIN_SETTINGS_FOR_UPDATE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DomainSettingsForUpdate")
.getter(getter(UpdateDomainRequest::domainSettingsForUpdate)).setter(setter(Builder::domainSettingsForUpdate))
.constructor(DomainSettingsForUpdate::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainSettingsForUpdate").build())
.build();
private static final SdkField APP_SECURITY_GROUP_MANAGEMENT_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("AppSecurityGroupManagement")
.getter(getter(UpdateDomainRequest::appSecurityGroupManagementAsString))
.setter(setter(Builder::appSecurityGroupManagement))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AppSecurityGroupManagement").build())
.build();
private static final SdkField DEFAULT_SPACE_SETTINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DefaultSpaceSettings")
.getter(getter(UpdateDomainRequest::defaultSpaceSettings)).setter(setter(Builder::defaultSpaceSettings))
.constructor(DefaultSpaceSettings::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultSpaceSettings").build())
.build();
private static final SdkField> SUBNET_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SubnetIds")
.getter(getter(UpdateDomainRequest::subnetIds))
.setter(setter(Builder::subnetIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubnetIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField APP_NETWORK_ACCESS_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AppNetworkAccessType").getter(getter(UpdateDomainRequest::appNetworkAccessTypeAsString))
.setter(setter(Builder::appNetworkAccessType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AppNetworkAccessType").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_ID_FIELD,
DEFAULT_USER_SETTINGS_FIELD, DOMAIN_SETTINGS_FOR_UPDATE_FIELD, APP_SECURITY_GROUP_MANAGEMENT_FIELD,
DEFAULT_SPACE_SETTINGS_FIELD, SUBNET_IDS_FIELD, APP_NETWORK_ACCESS_TYPE_FIELD));
private final String domainId;
private final UserSettings defaultUserSettings;
private final DomainSettingsForUpdate domainSettingsForUpdate;
private final String appSecurityGroupManagement;
private final DefaultSpaceSettings defaultSpaceSettings;
private final List subnetIds;
private final String appNetworkAccessType;
private UpdateDomainRequest(BuilderImpl builder) {
super(builder);
this.domainId = builder.domainId;
this.defaultUserSettings = builder.defaultUserSettings;
this.domainSettingsForUpdate = builder.domainSettingsForUpdate;
this.appSecurityGroupManagement = builder.appSecurityGroupManagement;
this.defaultSpaceSettings = builder.defaultSpaceSettings;
this.subnetIds = builder.subnetIds;
this.appNetworkAccessType = builder.appNetworkAccessType;
}
/**
*
* The ID of the domain to be updated.
*
*
* @return The ID of the domain to be updated.
*/
public final String domainId() {
return domainId;
}
/**
*
* A collection of settings.
*
*
* @return A collection of settings.
*/
public final UserSettings defaultUserSettings() {
return defaultUserSettings;
}
/**
*
* A collection of DomainSettings configuration values to update.
*
*
* @return A collection of DomainSettings configuration values to update.
*/
public final DomainSettingsForUpdate domainSettingsForUpdate() {
return domainSettingsForUpdate;
}
/**
*
* 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,
* {@link #appSecurityGroupManagement} will return {@link AppSecurityGroupManagement#UNKNOWN_TO_SDK_VERSION}. The
* raw value returned by the service is available from {@link #appSecurityGroupManagementAsString}.
*
*
* @return 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 AppSecurityGroupManagement
*/
public final AppSecurityGroupManagement appSecurityGroupManagement() {
return AppSecurityGroupManagement.fromValue(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,
* {@link #appSecurityGroupManagement} will return {@link AppSecurityGroupManagement#UNKNOWN_TO_SDK_VERSION}. The
* raw value returned by the service is available from {@link #appSecurityGroupManagementAsString}.
*
*
* @return 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 AppSecurityGroupManagement
*/
public final String appSecurityGroupManagementAsString() {
return appSecurityGroupManagement;
}
/**
*
* The default settings used to create a space within the domain.
*
*
* @return The default settings used to create a space within the domain.
*/
public final DefaultSpaceSettings defaultSpaceSettings() {
return defaultSpaceSettings;
}
/**
* 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 {@code 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.
*/
public final boolean hasSubnetIds() {
return subnetIds != null && !(subnetIds instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasSubnetIds} method.
*
*
* @return The VPC subnets that Studio uses for communication.
*
* If removing subnets, ensure there are no apps in the InService, Pending, or
* Deleting state.
*/
public final List subnetIds() {
return subnetIds;
}
/**
*
* 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.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #appNetworkAccessType} will return {@link AppNetworkAccessType#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #appNetworkAccessTypeAsString}.
*
*
* @return 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 AppNetworkAccessType
*/
public final AppNetworkAccessType appNetworkAccessType() {
return AppNetworkAccessType.fromValue(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.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #appNetworkAccessType} will return {@link AppNetworkAccessType#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #appNetworkAccessTypeAsString}.
*
*
* @return 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 AppNetworkAccessType
*/
public final String appNetworkAccessTypeAsString() {
return appNetworkAccessType;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(domainId());
hashCode = 31 * hashCode + Objects.hashCode(defaultUserSettings());
hashCode = 31 * hashCode + Objects.hashCode(domainSettingsForUpdate());
hashCode = 31 * hashCode + Objects.hashCode(appSecurityGroupManagementAsString());
hashCode = 31 * hashCode + Objects.hashCode(defaultSpaceSettings());
hashCode = 31 * hashCode + Objects.hashCode(hasSubnetIds() ? subnetIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(appNetworkAccessTypeAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UpdateDomainRequest)) {
return false;
}
UpdateDomainRequest other = (UpdateDomainRequest) obj;
return Objects.equals(domainId(), other.domainId()) && Objects.equals(defaultUserSettings(), other.defaultUserSettings())
&& Objects.equals(domainSettingsForUpdate(), other.domainSettingsForUpdate())
&& Objects.equals(appSecurityGroupManagementAsString(), other.appSecurityGroupManagementAsString())
&& Objects.equals(defaultSpaceSettings(), other.defaultSpaceSettings()) && hasSubnetIds() == other.hasSubnetIds()
&& Objects.equals(subnetIds(), other.subnetIds())
&& Objects.equals(appNetworkAccessTypeAsString(), other.appNetworkAccessTypeAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("UpdateDomainRequest").add("DomainId", domainId())
.add("DefaultUserSettings", defaultUserSettings()).add("DomainSettingsForUpdate", domainSettingsForUpdate())
.add("AppSecurityGroupManagement", appSecurityGroupManagementAsString())
.add("DefaultSpaceSettings", defaultSpaceSettings()).add("SubnetIds", hasSubnetIds() ? subnetIds() : null)
.add("AppNetworkAccessType", appNetworkAccessTypeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DomainId":
return Optional.ofNullable(clazz.cast(domainId()));
case "DefaultUserSettings":
return Optional.ofNullable(clazz.cast(defaultUserSettings()));
case "DomainSettingsForUpdate":
return Optional.ofNullable(clazz.cast(domainSettingsForUpdate()));
case "AppSecurityGroupManagement":
return Optional.ofNullable(clazz.cast(appSecurityGroupManagementAsString()));
case "DefaultSpaceSettings":
return Optional.ofNullable(clazz.cast(defaultSpaceSettings()));
case "SubnetIds":
return Optional.ofNullable(clazz.cast(subnetIds()));
case "AppNetworkAccessType":
return Optional.ofNullable(clazz.cast(appNetworkAccessTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateDomainRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the domain to be updated.
*
*
* @param domainId
* The ID of the domain to be updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainId(String domainId);
/**
*
* A collection of settings.
*
*
* @param defaultUserSettings
* A collection of settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultUserSettings(UserSettings defaultUserSettings);
/**
*
* A collection of settings.
*
* This is a convenience method that creates an instance of the {@link UserSettings.Builder} avoiding the need
* to create one manually via {@link UserSettings#builder()}.
*
*
* When the {@link Consumer} completes, {@link UserSettings.Builder#build()} is called immediately and its
* result is passed to {@link #defaultUserSettings(UserSettings)}.
*
* @param defaultUserSettings
* a consumer that will call methods on {@link UserSettings.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #defaultUserSettings(UserSettings)
*/
default Builder defaultUserSettings(Consumer defaultUserSettings) {
return defaultUserSettings(UserSettings.builder().applyMutation(defaultUserSettings).build());
}
/**
*
* A collection of DomainSettings configuration values to update.
*
*
* @param domainSettingsForUpdate
* A collection of DomainSettings configuration values to update.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainSettingsForUpdate(DomainSettingsForUpdate domainSettingsForUpdate);
/**
*
* A collection of DomainSettings configuration values to update.
*
* This is a convenience method that creates an instance of the {@link DomainSettingsForUpdate.Builder} avoiding
* the need to create one manually via {@link DomainSettingsForUpdate#builder()}.
*
*
* When the {@link Consumer} completes, {@link DomainSettingsForUpdate.Builder#build()} is called immediately
* and its result is passed to {@link #domainSettingsForUpdate(DomainSettingsForUpdate)}.
*
* @param domainSettingsForUpdate
* a consumer that will call methods on {@link DomainSettingsForUpdate.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #domainSettingsForUpdate(DomainSettingsForUpdate)
*/
default Builder domainSettingsForUpdate(Consumer domainSettingsForUpdate) {
return domainSettingsForUpdate(DomainSettingsForUpdate.builder().applyMutation(domainSettingsForUpdate).build());
}
/**
*
* 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.
*
*
* @param 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 AppSecurityGroupManagement
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppSecurityGroupManagement
*/
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.
*
*
* @param 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 AppSecurityGroupManagement
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppSecurityGroupManagement
*/
Builder appSecurityGroupManagement(AppSecurityGroupManagement appSecurityGroupManagement);
/**
*
* The default settings used to create a space within the domain.
*
*
* @param defaultSpaceSettings
* The default settings used to create a space within the domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings);
/**
*
* The default settings used to create a space within the domain.
*
* This is a convenience method that creates an instance of the {@link DefaultSpaceSettings.Builder} avoiding
* the need to create one manually via {@link DefaultSpaceSettings#builder()}.
*
*
* When the {@link Consumer} completes, {@link DefaultSpaceSettings.Builder#build()} is called immediately and
* its result is passed to {@link #defaultSpaceSettings(DefaultSpaceSettings)}.
*
* @param defaultSpaceSettings
* a consumer that will call methods on {@link DefaultSpaceSettings.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #defaultSpaceSettings(DefaultSpaceSettings)
*/
default Builder defaultSpaceSettings(Consumer defaultSpaceSettings) {
return defaultSpaceSettings(DefaultSpaceSettings.builder().applyMutation(defaultSpaceSettings).build());
}
/**
*
* The VPC subnets that Studio uses for communication.
*
*
* If removing subnets, ensure there are no apps in the InService, Pending, or
* Deleting state.
*
*
* @param subnetIds
* The VPC subnets that Studio uses for communication.
*
* If removing subnets, ensure there are no apps in the InService, Pending, or
* Deleting state.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnetIds(Collection subnetIds);
/**
*
* The VPC subnets that Studio uses for communication.
*
*
* If removing subnets, ensure there are no apps in the InService, Pending, or
* Deleting state.
*
*
* @param subnetIds
* The VPC subnets that Studio uses for communication.
*
* If removing subnets, ensure there are no apps in the InService, Pending, or
* Deleting state.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subnetIds(String... subnetIds);
/**
*
* 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.
*
*
* @param 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 AppNetworkAccessType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppNetworkAccessType
*/
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.
*
*
* @param 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 AppNetworkAccessType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppNetworkAccessType
*/
Builder appNetworkAccessType(AppNetworkAccessType appNetworkAccessType);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String domainId;
private UserSettings defaultUserSettings;
private DomainSettingsForUpdate domainSettingsForUpdate;
private String appSecurityGroupManagement;
private DefaultSpaceSettings defaultSpaceSettings;
private List subnetIds = DefaultSdkAutoConstructList.getInstance();
private String appNetworkAccessType;
private BuilderImpl() {
}
private BuilderImpl(UpdateDomainRequest model) {
super(model);
domainId(model.domainId);
defaultUserSettings(model.defaultUserSettings);
domainSettingsForUpdate(model.domainSettingsForUpdate);
appSecurityGroupManagement(model.appSecurityGroupManagement);
defaultSpaceSettings(model.defaultSpaceSettings);
subnetIds(model.subnetIds);
appNetworkAccessType(model.appNetworkAccessType);
}
public final String getDomainId() {
return domainId;
}
public final void setDomainId(String domainId) {
this.domainId = domainId;
}
@Override
public final Builder domainId(String domainId) {
this.domainId = domainId;
return this;
}
public final UserSettings.Builder getDefaultUserSettings() {
return defaultUserSettings != null ? defaultUserSettings.toBuilder() : null;
}
public final void setDefaultUserSettings(UserSettings.BuilderImpl defaultUserSettings) {
this.defaultUserSettings = defaultUserSettings != null ? defaultUserSettings.build() : null;
}
@Override
public final Builder defaultUserSettings(UserSettings defaultUserSettings) {
this.defaultUserSettings = defaultUserSettings;
return this;
}
public final DomainSettingsForUpdate.Builder getDomainSettingsForUpdate() {
return domainSettingsForUpdate != null ? domainSettingsForUpdate.toBuilder() : null;
}
public final void setDomainSettingsForUpdate(DomainSettingsForUpdate.BuilderImpl domainSettingsForUpdate) {
this.domainSettingsForUpdate = domainSettingsForUpdate != null ? domainSettingsForUpdate.build() : null;
}
@Override
public final Builder domainSettingsForUpdate(DomainSettingsForUpdate domainSettingsForUpdate) {
this.domainSettingsForUpdate = domainSettingsForUpdate;
return this;
}
public final String getAppSecurityGroupManagement() {
return appSecurityGroupManagement;
}
public final void setAppSecurityGroupManagement(String appSecurityGroupManagement) {
this.appSecurityGroupManagement = appSecurityGroupManagement;
}
@Override
public final Builder appSecurityGroupManagement(String appSecurityGroupManagement) {
this.appSecurityGroupManagement = appSecurityGroupManagement;
return this;
}
@Override
public final Builder appSecurityGroupManagement(AppSecurityGroupManagement appSecurityGroupManagement) {
this.appSecurityGroupManagement(appSecurityGroupManagement == null ? null : appSecurityGroupManagement.toString());
return this;
}
public final DefaultSpaceSettings.Builder getDefaultSpaceSettings() {
return defaultSpaceSettings != null ? defaultSpaceSettings.toBuilder() : null;
}
public final void setDefaultSpaceSettings(DefaultSpaceSettings.BuilderImpl defaultSpaceSettings) {
this.defaultSpaceSettings = defaultSpaceSettings != null ? defaultSpaceSettings.build() : null;
}
@Override
public final Builder defaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings) {
this.defaultSpaceSettings = defaultSpaceSettings;
return this;
}
public final Collection getSubnetIds() {
if (subnetIds instanceof SdkAutoConstructList) {
return null;
}
return subnetIds;
}
public final void setSubnetIds(Collection subnetIds) {
this.subnetIds = SubnetsCopier.copy(subnetIds);
}
@Override
public final Builder subnetIds(Collection subnetIds) {
this.subnetIds = SubnetsCopier.copy(subnetIds);
return this;
}
@Override
@SafeVarargs
public final Builder subnetIds(String... subnetIds) {
subnetIds(Arrays.asList(subnetIds));
return this;
}
public final String getAppNetworkAccessType() {
return appNetworkAccessType;
}
public final void setAppNetworkAccessType(String appNetworkAccessType) {
this.appNetworkAccessType = appNetworkAccessType;
}
@Override
public final Builder appNetworkAccessType(String appNetworkAccessType) {
this.appNetworkAccessType = appNetworkAccessType;
return this;
}
@Override
public final Builder appNetworkAccessType(AppNetworkAccessType appNetworkAccessType) {
this.appNetworkAccessType(appNetworkAccessType == null ? null : appNetworkAccessType.toString());
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public UpdateDomainRequest build() {
return new UpdateDomainRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}