Class UpdateDomainRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateDomainRequest.Builder,
UpdateDomainRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AppNetworkAccessType
Specifies the VPC used for non-EFS traffic.final String
Specifies the VPC used for non-EFS traffic.The entity that creates and manages the required security groups for inter-app communication inVPCOnly
mode.final String
The entity that creates and manages the required security groups for inter-app communication inVPCOnly
mode.static UpdateDomainRequest.Builder
builder()
final DefaultSpaceSettings
The default settings used to create a space within the domain.final UserSettings
A collection of settings.final String
domainId()
The ID of the domain to be updated.final DomainSettingsForUpdate
A collection ofDomainSettings
configuration values to update.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SubnetIds property.static Class
<? extends UpdateDomainRequest.Builder> The VPC subnets that Studio uses for communication.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
domainId
The ID of the domain to be updated.
- Returns:
- The ID of the domain to be updated.
-
defaultUserSettings
A collection of settings.
- Returns:
- A collection of settings.
-
domainSettingsForUpdate
A collection of
DomainSettings
configuration values to update.- Returns:
- A collection of
DomainSettings
configuration values to update.
-
appSecurityGroupManagement
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required whenCreateDomain.AppNetworkAccessType
isVPCOnly
andDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided. If setting up the domain for use with RStudio, this value must be set toService
.If the service returns an enum value that is not available in the current SDK version,
appSecurityGroupManagement
will returnAppSecurityGroupManagement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromappSecurityGroupManagementAsString()
.- Returns:
- The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required whenCreateDomain.AppNetworkAccessType
isVPCOnly
andDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided. If setting up the domain for use with RStudio, this value must be set toService
. - See Also:
-
appSecurityGroupManagementAsString
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required whenCreateDomain.AppNetworkAccessType
isVPCOnly
andDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided. If setting up the domain for use with RStudio, this value must be set toService
.If the service returns an enum value that is not available in the current SDK version,
appSecurityGroupManagement
will returnAppSecurityGroupManagement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromappSecurityGroupManagementAsString()
.- Returns:
- The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required whenCreateDomain.AppNetworkAccessType
isVPCOnly
andDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided. If setting up the domain for use with RStudio, this value must be set toService
. - See Also:
-
defaultSpaceSettings
The default settings used to create a space within the domain.
- Returns:
- The default settings used to create a space within 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 theisEmpty()
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
The VPC subnets that Studio uses for communication.
If removing subnets, ensure there are no apps in the
InService
,Pending
, orDeleting
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
, orDeleting
state.
-
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
, orDeleting
state. The configuration cannot be updated ifDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is already set orDomainSettings.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 returnAppNetworkAccessType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromappNetworkAccessTypeAsString()
.- 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
, orDeleting
state. The configuration cannot be updated ifDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is already set orDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided as part of the same request. -
- See Also:
-
-
appNetworkAccessTypeAsString
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
, orDeleting
state. The configuration cannot be updated ifDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is already set orDomainSettings.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 returnAppNetworkAccessType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromappNetworkAccessTypeAsString()
.- 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
, orDeleting
state. The configuration cannot be updated ifDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is already set orDomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided as part of the same request. -
- See Also:
-
-
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 interfaceToCopyableBuilder<UpdateDomainRequest.Builder,
UpdateDomainRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-