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

Class DomainSettings

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.DomainSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DomainSettings.Builder,DomainSettings>

@Generated("software.amazon.awssdk:codegen")
public final class DomainSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DomainSettings.Builder,DomainSettings>

A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DomainSettings.Builder

Method Summary

Modifier and Type	Method	Description
static DomainSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExecutionRoleIdentityConfig	executionRoleIdentityConfig()	The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
String	executionRoleIdentityConfigAsString()	The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSecurityGroupIds()	For responses, this returns true if the service returned a value for the SecurityGroupIds property.
RStudioServerProDomainSettings	rStudioServerProDomainSettings()	A collection of settings that configure the RStudioServerPro Domain-level app.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds()	The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
static Class<? extends DomainSettings.Builder>	serializableBuilderClass()
DomainSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasSecurityGroupIds

public final boolean hasSecurityGroupIds()

For responses, this returns true if the service returned a value for the SecurityGroupIds 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.

securityGroupIds

public final List<String> securityGroupIds()

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

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 hasSecurityGroupIds() method.

Returns:

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

rStudioServerProDomainSettings

public final RStudioServerProDomainSettings rStudioServerProDomainSettings()

A collection of settings that configure the RStudioServerPro Domain-level app.

Returns:

A collection of settings that configure the RStudioServerPro Domain-level app.

executionRoleIdentityConfig

public final ExecutionRoleIdentityConfig executionRoleIdentityConfig()

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

If the service returns an enum value that is not available in the current SDK version, executionRoleIdentityConfig will return ExecutionRoleIdentityConfig.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionRoleIdentityConfigAsString().

Returns:

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

See Also:

ExecutionRoleIdentityConfig

executionRoleIdentityConfigAsString

public final String executionRoleIdentityConfigAsString()

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

If the service returns an enum value that is not available in the current SDK version, executionRoleIdentityConfig will return ExecutionRoleIdentityConfig.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionRoleIdentityConfigAsString().

Returns:

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

See Also:

ExecutionRoleIdentityConfig

toBuilder

public DomainSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DomainSettings.Builder,DomainSettings>

builder

public static DomainSettings.Builder builder()

serializableBuilderClass

public static Class<? extends DomainSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo