Class JupyterLabAppSettings
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.JupyterLabAppSettings
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<JupyterLabAppSettings.Builder,JupyterLabAppSettings>
@Generated("software.amazon.awssdk:codegen") public final class JupyterLabAppSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JupyterLabAppSettings.Builder,JupyterLabAppSettings>
The settings for the JupyterLab application.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
JupyterLabAppSettings.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AppLifecycleManagement
appLifecycleManagement()
Indicates whether idle shutdown is activated for JupyterLab applications.static JupyterLabAppSettings.Builder
builder()
String
builtInLifecycleConfigArn()
The lifecycle configuration that runs before the default lifecycle configuration.List<CodeRepository>
codeRepositories()
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.List<CustomImage>
customImages()
A list of custom SageMaker images that are configured to run as a JupyterLab app.ResourceSpec
defaultResourceSpec()
Returns the value of the DefaultResourceSpec property for this object.EmrSettings
emrSettings()
The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasCodeRepositories()
For responses, this returns true if the service returned a value for the CodeRepositories property.boolean
hasCustomImages()
For responses, this returns true if the service returned a value for the CustomImages property.int
hashCode()
boolean
hasLifecycleConfigArns()
For responses, this returns true if the service returned a value for the LifecycleConfigArns property.List<String>
lifecycleConfigArns()
The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends JupyterLabAppSettings.Builder>
serializableBuilderClass()
JupyterLabAppSettings.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
-
defaultResourceSpec
public final ResourceSpec defaultResourceSpec()
Returns the value of the DefaultResourceSpec property for this object.- Returns:
- The value of the DefaultResourceSpec property for this object.
-
hasCustomImages
public final boolean hasCustomImages()
For responses, this returns true if the service returned a value for the CustomImages 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.
-
customImages
public final List<CustomImage> customImages()
A list of custom SageMaker images that are configured to run as a JupyterLab app.
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
hasCustomImages()
method.- Returns:
- A list of custom SageMaker images that are configured to run as a JupyterLab app.
-
hasLifecycleConfigArns
public final boolean hasLifecycleConfigArns()
For responses, this returns true if the service returned a value for the LifecycleConfigArns 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.
-
lifecycleConfigArns
public final List<String> lifecycleConfigArns()
The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set
LifecycleConfigArns
to an empty list.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
hasLifecycleConfigArns()
method.- Returns:
- The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To
remove a lifecycle config, you must set
LifecycleConfigArns
to an empty list.
-
hasCodeRepositories
public final boolean hasCodeRepositories()
For responses, this returns true if the service returned a value for the CodeRepositories 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.
-
codeRepositories
public final List<CodeRepository> codeRepositories()
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
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
hasCodeRepositories()
method.- Returns:
- A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
-
appLifecycleManagement
public final AppLifecycleManagement appLifecycleManagement()
Indicates whether idle shutdown is activated for JupyterLab applications.
- Returns:
- Indicates whether idle shutdown is activated for JupyterLab applications.
-
emrSettings
public final EmrSettings emrSettings()
The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.
- Returns:
- The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.
-
builtInLifecycleConfigArn
public final String builtInLifecycleConfigArn()
The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
- Returns:
- The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
-
toBuilder
public JupyterLabAppSettings.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<JupyterLabAppSettings.Builder,JupyterLabAppSettings>
-
builder
public static JupyterLabAppSettings.Builder builder()
-
serializableBuilderClass
public static Class<? extends JupyterLabAppSettings.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-