Package software.amazon.awscdk.services.sagemaker

Interface CfnDomain.IdleSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.IdleSettingsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.IdleSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Settings related to idle shutdown of Studio applications.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 IdleSettingsProperty idleSettingsProperty = IdleSettingsProperty.builder()
         .idleTimeoutInMinutes(123)
         .lifecycleManagement("lifecycleManagement")
         .maxIdleTimeoutInMinutes(123)
         .minIdleTimeoutInMinutes(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-idlesettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.IdleSettingsProperty.Builder	A builder for CfnDomain.IdleSettingsProperty
static final class	CfnDomain.IdleSettingsProperty.Jsii$Proxy	An implementation for CfnDomain.IdleSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.IdleSettingsProperty.Builder	builder()
default Number	getIdleTimeoutInMinutes()	The time that SageMaker waits after the application becomes idle before shutting it down.
default String	getLifecycleManagement()	Indicates whether idle shutdown is activated for the application type.
default Number	getMaxIdleTimeoutInMinutes()	The maximum value in minutes that custom idle shutdown can be set to by the user.
default Number	getMinIdleTimeoutInMinutes()	The minimum value in minutes that custom idle shutdown can be set to by the user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdleTimeoutInMinutes

@Stability(Stable)
@Nullable
default Number getIdleTimeoutInMinutes()

The time that SageMaker waits after the application becomes idle before shutting it down.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-idlesettings.html#cfn-sagemaker-domain-idlesettings-idletimeoutinminutes

getLifecycleManagement

@Stability(Stable)
@Nullable
default String getLifecycleManagement()

Indicates whether idle shutdown is activated for the application type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-idlesettings.html#cfn-sagemaker-domain-idlesettings-lifecyclemanagement

getMaxIdleTimeoutInMinutes

@Stability(Stable)
@Nullable
default Number getMaxIdleTimeoutInMinutes()

The maximum value in minutes that custom idle shutdown can be set to by the user.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-idlesettings.html#cfn-sagemaker-domain-idlesettings-maxidletimeoutinminutes

getMinIdleTimeoutInMinutes

@Stability(Stable)
@Nullable
default Number getMinIdleTimeoutInMinutes()

The minimum value in minutes that custom idle shutdown can be set to by the user.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-idlesettings.html#cfn-sagemaker-domain-idlesettings-minidletimeoutinminutes

builder

@Stability(Stable)
static CfnDomain.IdleSettingsProperty.Builder builder()

Returns:

a CfnDomain.IdleSettingsProperty.Builder of CfnDomain.IdleSettingsProperty